HIV Case Reporting and Monitoring
0.2.0 - CI Build
HIV Case Reporting and Monitoring
0.2.0 - CI Build
HIV Case Reporting and Monitoring - Local Development build (v0.2.0). See the Directory of published versions
| Official URL: http://openhie.org/fhir/hiv-casereporting/StructureDefinition/hiv-episode-of-care | Version: 0.2.0 | |||
| Active as of 2022-10-06 | Responsible: OpenHIE |
Realm: 
|
Computable Name: HIVEpisodeOfCare | |
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from EpisodeOfCare
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
  identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
  system | 0..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/hiv-casereporting/identifier/enrollment-unique-id | |
 diagnosis | S | 1..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
| managingOrganization | S | 1..1 | Reference(Organization) | Organization that assumes care |
| period | ||||
| start | S | 1..1 | dateTime | Starting time with inclusive boundary |
| referralRequest | S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
 id | Σ | 0..1 | id | Logical id of this artifact | ||||
 meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/hiv-casereporting/identifier/enrollment-unique-id | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| diagnosis | SΣ | 1..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | SΣ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
| period | Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest | S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | ||||
| careManager | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team | 0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| identifier | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | |
| diagnosis | Σ | 1..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
| managingOrganization | Σ | 1..1 | Reference(Organization) | Organization that assumes care |
| period | Σ | 0..1 | Period | Interval during responsibility is assumed |
| start | ΣC | 1..1 | dateTime | Starting time with inclusive boundary |
| referralRequest | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | |
| Documentation for this format | ||||
This structure is derived from EpisodeOfCare
Differential View
This structure is derived from EpisodeOfCare
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |
| identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare |
| system | 0..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/hiv-casereporting/identifier/enrollment-unique-id | |
| diagnosis | S | 1..1 | BackboneElement | The list of diagnosis relevant to this episode of care |
| managingOrganization | S | 1..1 | Reference(Organization) | Organization that assumes care |
| period | ||||
| start | S | 1..1 | dateTime | Starting time with inclusive boundary |
| referralRequest | S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| EpisodeOfCare | 0..* | EpisodeOfCare | An association of a Patient with an Organization and Healthcare Provider(s) for a period of time that the Organization assumes some level of responsibility | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | S | 1..* | Identifier | Business Identifier(s) relevant for this EpisodeOfCare | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
| system | Σ | 0..1 | uri | The namespace for the identifier value Required Pattern: http://openhie.org/fhir/hiv-casereporting/identifier/enrollment-unique-id | ||||
| value | Σ | 0..1 | string | The value that is unique Example General: 123456 | ||||
| period | Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
| status | ?!Σ | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | ||||
| statusHistory | 0..* | BackboneElement | Past list of status codes (the current status may be included to cover the start date of the status) | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | waitlist | active | onhold | finished | cancelled | entered-in-error Binding: EpisodeOfCareStatus (required): The status of the episode of care. | |||||
| period | 1..1 | Period | Duration the EpisodeOfCare was in the specified status | |||||
| type | Σ | 0..* | CodeableConcept | Type/class - e.g. specialist referral, disease management Binding: EpisodeOfCareType (example): The type of the episode of care. | ||||
| diagnosis | SΣ | 1..1 | BackboneElement | The list of diagnosis relevant to this episode of care | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition) | Conditions/problems/diagnoses this episode of care is for | ||||
| role | Σ | 0..1 | CodeableConcept | Role that this diagnosis has within the episode of care (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | ||||
| rank | Σ | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
| patient | Σ | 1..1 | Reference(Patient) | The patient who is the focus of this episode of care | ||||
| managingOrganization | SΣ | 1..1 | Reference(Organization) | Organization that assumes care | ||||
| period | Σ | 0..1 | Period | Interval during responsibility is assumed | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | SΣC | 1..1 | dateTime | Starting time with inclusive boundary | ||||
| end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
| referralRequest | S | 0..* | Reference(ServiceRequest) | Originating Referral Request(s) | ||||
| careManager | 0..1 | Reference(Practitioner | PractitionerRole) | Care manager/care coordinator for the patient | |||||
| team | 0..* | Reference(CareTeam) | Other practitioners facilitating this episode of care | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this EpisodeOfCare | |||||
| Documentation for this format | ||||||||
Other representations of profile: CSV, Excel, Schematron
| Path | Conformance | ValueSet |
| EpisodeOfCare.language | preferred | CommonLanguages Max Binding: AllLanguages |
| EpisodeOfCare.identifier.use | required | IdentifierUse |
| EpisodeOfCare.identifier.type | extensible | Identifier Type Codes |
| EpisodeOfCare.status | required | EpisodeOfCareStatus |
| EpisodeOfCare.statusHistory.status | required | EpisodeOfCareStatus |
| EpisodeOfCare.type | example | EpisodeOfCareType |
| EpisodeOfCare.diagnosis.role | preferred | DiagnosisRole |
| Id | Grade | Path | Details | Requirements |
| dom-2 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | EpisodeOfCare | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | EpisodeOfCare | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | Best Practice | EpisodeOfCare | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | EpisodeOfCare.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.statusHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.statusHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.statusHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.statusHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.statusHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.statusHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.statusHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.diagnosis | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.diagnosis.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.diagnosis.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.diagnosis.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.diagnosis.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.diagnosis.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.diagnosis.role | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.diagnosis.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.patient | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.managingOrganization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.period.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | EpisodeOfCare.period.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | error | EpisodeOfCare.period.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.period.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.referralRequest | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.careManager | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.team | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | error | EpisodeOfCare.account | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2019+ OpenHIE. Package openhie.fhir.hiv#0.2.0 based on FHIR 4.0.1. Generated 2022-10-06
Links: Table of Contents |
QA Report |
Version History |
|