Zambia Immunizations FHIR Implementation Guide
1.0.1 - ci-build
Zambia Immunizations FHIR Implementation Guide, published by Jembi Health Systems. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/jembi/Zambia-Immunizations/ and changes regularly. See the Directory of published versions
Official URL: http://moh.gov.zm/fhir/immunizations/StructureDefinition/smartcare-target-facility-encounter | Version: 1.0.1 | |||
Active as of 2024-09-30 | Computable Name: SmartcareTargetFacilityEncounter |
Represents the current facility at which the patient is receiving health services.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from TargetFacilityEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | TargetFacilityEncounter | |||
subject | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter | |
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | TargetFacilityEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
class | Σ | 1..1 | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. |
subject | Σ | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter |
serviceProvider | S | 0..1 | Reference(Organization - Healthcare Service Provider Profile) | The organization (facility) responsible for this encounter |
actualPeriod | 1..1 | Period | The actual start and end time of the encounter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | TargetFacilityEncounter | An interaction during which services are provided to the patient | |||||
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: AllLanguages (required): IETF language tag for 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 | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
class | Σ | 1..1 | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: AMB | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||
serviceType | Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
subject | Σ | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter | ||||
subjectStatus | 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
careTeam | 0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
serviceProvider | S | 0..1 | Reference(Organization - Healthcare Service Provider Profile) | The organization (facility) responsible for this encounter | ||||
participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter enc-1: A type must be provided when no explicit actor is specified enc-2: A type cannot be provided for a patient or group participant | ||||
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 | ||||
type | ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
actualPeriod | 1..1 | Period | The actual start and end time of the encounter | |||||
plannedStartDate | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
plannedEndDate | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
length | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the 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 | ||||
use | Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
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 | Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
use | 0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
admission | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
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 | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
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 | ||||
location | 1..1 | Reference(Location) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
form | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status from the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard | |
Encounter.reason.value | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.condition | example | ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
Encounter.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use from the FHIR Standard | |
Encounter.dietPreference | example | EncounterDiethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | |
Encounter.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | |
Encounter.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | |
Encounter.admission.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.admission.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 from the FHIR Standard | |
Encounter.location.form | example | LocationFormhttp://hl7.org/fhir/ValueSet/location-form from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from TargetFacilityEncounter
Differential View
This structure is derived from TargetFacilityEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | TargetFacilityEncounter | |||
subject | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter | |
Documentation for this format |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | TargetFacilityEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
contained | 0..* | Resource | Contained, inline Resources | |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
class | Σ | 1..1 | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. |
subject | Σ | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter |
serviceProvider | S | 0..1 | Reference(Organization - Healthcare Service Provider Profile) | The organization (facility) responsible for this encounter |
actualPeriod | 1..1 | Period | The actual start and end time of the encounter | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | TargetFacilityEncounter | An interaction during which services are provided to the patient | |||||
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: AllLanguages (required): IETF language tag for 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 | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
class | Σ | 1..1 | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
coding | Σ | 0..* | Coding | Code defined by a terminology system | ||||
id | 0..1 | id | Unique id for inter-element referencing | |||||
extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
system | Σ | 0..1 | uri | Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/v3-ActCode | ||||
version | Σ | 0..1 | string | Version of the system - if relevant | ||||
code | ΣC | 0..1 | code | Symbol in syntax defined by the system Required Pattern: AMB | ||||
display | ΣC | 0..1 | string | Representation defined by the system | ||||
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
text | Σ | 0..1 | string | Plain text representation of the concept | ||||
priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||
serviceType | Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
subject | Σ | 1..1 | Reference(Patient - Smartcare Immunization Patient) | The patient or group related to this encounter | ||||
subjectStatus | 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||
episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
careTeam | 0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
serviceProvider | S | 0..1 | Reference(Organization - Healthcare Service Provider Profile) | The organization (facility) responsible for this encounter | ||||
participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter enc-1: A type must be provided when no explicit actor is specified enc-2: A type cannot be provided for a patient or group participant | ||||
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 | ||||
type | ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
actualPeriod | 1..1 | Period | The actual start and end time of the encounter | |||||
plannedStartDate | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
plannedEndDate | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
length | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the 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 | ||||
use | Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
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 | Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
use | 0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
admission | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
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 | ||||
preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
reAdmission | 0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||
destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
location | 0..* | BackboneElement | List of locations where the patient has been | |||||
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 | ||||
location | 1..1 | Reference(Location) | Location the encounter takes place | |||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
form | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.language | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|5.0.0 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|5.0.0 from the FHIR Standard | |
Encounter.class | preferred | EncounterClasshttp://terminology.hl7.org/ValueSet/encounter-class | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.subjectStatus | example | EncounterSubjectStatushttp://hl7.org/fhir/ValueSet/encounter-subject-status from the FHIR Standard | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reason.use | example | EncounterReasonUsehttp://hl7.org/fhir/ValueSet/encounter-reason-use from the FHIR Standard | |
Encounter.reason.value | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.diagnosis.condition | example | ConditionProblemDiagnosisCodeshttp://hl7.org/fhir/ValueSet/condition-code from the FHIR Standard | |
Encounter.diagnosis.use | preferred | EncounterDiagnosisUsehttp://hl7.org/fhir/ValueSet/encounter-diagnosis-use from the FHIR Standard | |
Encounter.dietPreference | example | EncounterDiethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | |
Encounter.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | |
Encounter.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | |
Encounter.admission.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | |
Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | |
Encounter.admission.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | |
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0 from the FHIR Standard | |
Encounter.location.form | example | LocationFormhttp://hl7.org/fhir/ValueSet/location-form from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
enc-2 | error | Encounter.participant | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from TargetFacilityEncounter
Other representations of profile: CSV, Excel, Schematron