NPHCDA Immunization FHIR IG
0.9.0 - ci-build Nigeria flag

NPHCDA Immunization FHIR IG, published by https://nphcda.gov.ng. This guide is not an authorized publication; it is the continuous build for version 0.9.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/Nigeria-FHIR-Community/NPHCDA-ImmunizationIG/ and changes regularly. See the Directory of published versions

Resource Profile: NG-Imm Encounter

Official URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-imm-encounter Version: 0.9.0
Active as of 2026-10-07 Computable Name: NgImmEncounter

A profile for encounters in the Nigerian Immunization guide, used to document immunization visits and related healthcare interactions.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the immunization encounter
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element is included in summaries. 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(NG-Imm Patient) The patient or group present at the encounter
Encounter.participant This element must be supported. This element is included in summaries. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.individual This element is included in summaries. 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().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 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()

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.status 1..1 code Status of the immunization encounter
Encounter.class 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.participant This element must be supported. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.individual 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the immunization encounter
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element is included in summaries. 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element is included in summaries. 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(NG-Imm Patient) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.participant This element must be supported. This element is included in summaries. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.id 0..1 string Unique id for inter-element referencing
Encounter.participant.extension 0..* Extension Additional content defined by implementations
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element is included in summaries. 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element is included in summaries. 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter
Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.4
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.4
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.4
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().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 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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the immunization encounter
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.class This element is included in summaries. 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(NG-Imm Patient) The patient or group present at the encounter
Encounter.participant This element must be supported. This element is included in summaries. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.individual This element is included in summaries. 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG

Constraints

Id Grade Path(s) Description Expression
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().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 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()

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.status 1..1 code Status of the immunization encounter
Encounter.class 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.subject This element must be supported. 1..1 Reference(NG-Imm Patient) The patient or group present at the encounter
Encounter.participant This element must be supported. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.individual 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Encounter 0..* Encounter An interaction during which services are provided to the patient
Encounter.id This element is included in summaries. 0..1 id Logical id of this artifact
Encounter.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Encounter.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Encounter.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Encounter.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Encounter.contained 0..* Resource Contained, inline Resources
Encounter.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
Encounter.Slices for extension.extension:signature This element must be supported. 0..1 Signature NG-Imm Encounter Signature
URL: https://nphcda.gov.ng/ig/StructureDefinition/ng-encounter-signature
Encounter.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Encounter.identifier This element is included in summaries. 0..* Identifier Identifier(s) by which this encounter is known
Encounter.status This element is a modifier element. This element is included in summaries. 1..1 code Status of the immunization encounter
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory 0..* BackboneElement List of past encounter statuses
Encounter.statusHistory.id 0..1 string Unique id for inter-element referencing
Encounter.statusHistory.extension 0..* Extension Additional content defined by implementations
Encounter.statusHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.statusHistory.status 1..1 code planned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required): Current state of the encounter.
Encounter.statusHistory.period 1..1 Period The time that the episode was in the specified status
Encounter.class This element is included in summaries. 1..1 Coding Type of encounter (e.g. Facility encounter, Outreach, or Home visit)
Binding: NG-Imm Session Type VS (extensible)
Encounter.classHistory 0..* BackboneElement List of past encounter classes
Encounter.classHistory.id 0..1 string Unique id for inter-element referencing
Encounter.classHistory.extension 0..* Extension Additional content defined by implementations
Encounter.classHistory.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.classHistory.class 1..1 Coding inpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible): Classification of the encounter.
Encounter.classHistory.period 1..1 Period The time that the episode was in the specified class
Encounter.type This element is included in summaries. 0..* CodeableConcept Specific type of encounter
Binding: EncounterType (example): The type of encounter.
Encounter.serviceType This element is included in summaries. 0..1 CodeableConcept Specific type of service
Binding: ServiceType (example): Broad categorization of the service that is to be provided.
Encounter.priority 0..1 CodeableConcept Indicates the urgency of the encounter
Binding: ActPriority (example): Indicates the urgency of the encounter.
Encounter.subject This element must be supported. This element is included in summaries. 1..1 Reference(NG-Imm Patient) The patient or group present at the encounter
Encounter.episodeOfCare This element is included in summaries. 0..* Reference(EpisodeOfCare) Episode(s) of care that this encounter should be recorded against
Encounter.basedOn 0..* Reference(ServiceRequest) The ServiceRequest that initiated this encounter
Encounter.participant This element must be supported. This element is included in summaries. 1..* BackboneElement List of participants involved in the encounter
Encounter.participant.id 0..1 string Unique id for inter-element referencing
Encounter.participant.extension 0..* Extension Additional content defined by implementations
Encounter.participant.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.participant.type This element is included in summaries. 0..* CodeableConcept Role of participant in encounter
Binding: ParticipantType (extensible): Role of participant in encounter.
Encounter.participant.period 0..1 Period Period of time during the encounter that the participant participated
Encounter.participant.individual This element is included in summaries. 0..1 Reference(NG-Imm Practitioner) Persons involved in the encounter other than the patient
Encounter.appointment This element is included in summaries. 0..* Reference(Appointment) The appointment that scheduled this encounter
Encounter.period 0..1 Period The start and end time of the encounter
Encounter.length 0..1 Duration Quantity of time the encounter lasted (less time absent)
Encounter.reasonCode This element is included in summaries. 0..* CodeableConcept Coded reason the encounter takes place
Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.
Encounter.reasonReference This element is included in summaries. 0..* Reference(Condition | Procedure | Observation | ImmunizationRecommendation) Reason the encounter takes place (reference)
Encounter.diagnosis This element is included in summaries. 0..* BackboneElement The list of diagnosis relevant to this encounter
Encounter.diagnosis.id 0..1 string Unique id for inter-element referencing
Encounter.diagnosis.extension 0..* Extension Additional content defined by implementations
Encounter.diagnosis.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.diagnosis.condition This element is included in summaries. 1..1 Reference(Condition | Procedure) The diagnosis or procedure relevant to the encounter
Encounter.diagnosis.use 0..1 CodeableConcept Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.
Encounter.diagnosis.rank 0..1 positiveInt Ranking of the diagnosis (for each role type)
Encounter.account 0..* Reference(Account) The set of accounts that may be used for billing for this Encounter
Encounter.hospitalization 0..1 BackboneElement Details about the admission to a healthcare service
Encounter.hospitalization.id 0..1 string Unique id for inter-element referencing
Encounter.hospitalization.extension 0..* Extension Additional content defined by implementations
Encounter.hospitalization.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.hospitalization.preAdmissionIdentifier 0..1 Identifier Pre-admission identifier
Encounter.hospitalization.origin 0..1 Reference(Location | Organization) The location/organization from which the patient came before admission
Encounter.hospitalization.admitSource 0..1 CodeableConcept From where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred): From where the patient was admitted.
Encounter.hospitalization.reAdmission 0..1 CodeableConcept The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.
Encounter.hospitalization.dietPreference 0..* CodeableConcept Diet preferences reported by the patient
Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.
Encounter.hospitalization.specialCourtesy 0..* CodeableConcept Special courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred): Special courtesies.
Encounter.hospitalization.specialArrangement 0..* CodeableConcept Wheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred): Special arrangements.
Encounter.hospitalization.destination 0..1 Reference(Location | Organization) Location/organization to which the patient is discharged
Encounter.hospitalization.dischargeDisposition 0..1 CodeableConcept Category or kind of location after discharge
Binding: DischargeDisposition (example): Discharge Disposition.
Encounter.location This element must be supported. 1..1 BackboneElement List of locations where the patient has been
Encounter.location.id 0..1 string Unique id for inter-element referencing
Encounter.location.extension 0..* Extension Additional content defined by implementations
Encounter.location.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Encounter.location.location 1..1 Reference(NG-Imm Location) Location the encounter takes place
Encounter.location.status 0..1 code planned | active | reserved | completed
Binding: EncounterLocationStatus (required): The status of the location.
Encounter.location.physicalType 0..1 CodeableConcept The physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example): Physical form of the location.
Encounter.location.period 0..1 Period Time period during which the patient was present at the location
Encounter.serviceProvider This element must be supported. 1..1 Reference(NG-Imm Organization) The organization (facility) responsible for this encounter
Encounter.partOf 0..1 Reference(Encounter) Another Encounter this encounter is part of

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Encounter.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Encounter.status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.statusHistory.​status Base required EncounterStatus 📍4.0.1 FHIR Std.
Encounter.class Base extensible NG-Imm Session Type VS 📦0.9.0 This IG
Encounter.classHistory.​class Base extensible ActEncounterCode 📦3.0.0 THO v7.4
Encounter.type Base example Encounter type 📍4.0.1 FHIR Std.
Encounter.serviceType Base example Service type 📍4.0.1 FHIR Std.
Encounter.priority Base example ActPriority 📦3.0.0 THO v7.4
Encounter.participant.​type Base extensible Participant type 📍4.0.1 FHIR Std.
Encounter.reasonCode Base preferred Encounter Reason Codes 📍4.0.1 FHIR Std.
Encounter.diagnosis.​use Base preferred DiagnosisRole 📍4.0.1 FHIR Std.
Encounter.hospitalization.​admitSource Base preferred Admit source 📍4.0.1 FHIR Std.
Encounter.hospitalization.​reAdmission Base example hl7VS-re-admissionIndicator 📦3.0.0 THO v7.4
Encounter.hospitalization.​dietPreference Base example Diet 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialCourtesy Base preferred Special courtesy 📍4.0.1 FHIR Std.
Encounter.hospitalization.​specialArrangement Base preferred Special arrangements 📍4.0.1 FHIR Std.
Encounter.hospitalization.​dischargeDisposition Base example Discharge disposition 📍4.0.1 FHIR Std.
Encounter.location.status Base required EncounterLocationStatus 📍4.0.1 FHIR Std.
Encounter.location.physicalType Base example Location type 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
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().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 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()

 

Other representations of profile: CSV, Excel, Schematron