WHO Antenatal Care Guideline Implementation Guide
0.3.0 - CI Build
WHO Antenatal Care Guideline Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/costateixeira/smart-anc/ and changes regularly. See the Directory of published versions
Official URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/anc-encounter | Version: 0.3.0 | |||
Draft as of 2024-09-10 | Computable Name: ANCEncounter | |||
Usage:Workflow Task: Gather client details |
ANC Encounter
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from ANCBaseEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | An interaction during which services are provided to the patient | |
Slices for extension | Content/Rules for all slices | |||
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |
period | 0..1 | Period | The start and end time of the encounter | |
start | S | 1..1 | dateTime | Contact date |
reasonCode | S | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. |
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
priority | S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. |
subject | SΣ | 0..1 | Reference(ANC Patient) | The patient or group present at the encounter |
episodeOfCare | SΣ | 0..* | Reference(CPGCase) | Episode(s) of care that this encounter should be recorded against |
basedOn | S | 0..* | Reference(ANC ServiceRequest) | The ServiceRequest that initiated this encounter |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(ANC Practitioner | ANC PractitionerRole) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
start | SΣC | 1..1 | dateTime | Contact date |
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
reasonCode | SΣ | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) |
diagnosis | SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(ANC Condition | ANC Procedure) | The diagnosis or procedure relevant to the encounter |
use | S | 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. |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(ANC Location) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(ANC Organization) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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() |
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | ||||
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
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 | ?!SΣ | 1..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 | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
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 | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
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 | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | ||||
subject | SΣ | 0..1 | Reference(ANC Patient) | The patient or group present at the encounter | ||||
episodeOfCare | SΣ | 0..* | Reference(CPGCase) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | S | 0..* | Reference(ANC ServiceRequest) | The ServiceRequest that initiated this encounter | ||||
participant | SΣ | 0..* | BackboneElement | List of participants involved in the 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 | ||||
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 0..1 | Reference(ANC Practitioner | ANC PractitionerRole) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
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 | Contact date | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | ||||
reasonCode | SΣ | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) | ||||
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | SΣ | 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 | SΣ | 1..1 | Reference(ANC Condition | ANC Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | S | 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. | ||||
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 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 | 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. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
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 | S | 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 | S | 1..1 | Reference(ANC Location) | Location the encounter takes place | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the 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. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(ANC Organization) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
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.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.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|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type 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().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 ANCBaseEncounter
Differential View
This structure is derived from ANCBaseEncounter
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | An interaction during which services are provided to the patient | |
Slices for extension | Content/Rules for all slices | |||
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |
period | 0..1 | Period | The start and end time of the encounter | |
start | S | 1..1 | dateTime | Contact date |
reasonCode | S | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | An interaction during which services are provided to the patient | |
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |
statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. |
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
identifier | SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known |
use | ?!SΣ | 1..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . |
system | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient |
value | SΣ | 1..1 | string | The value that is unique Example General: 123456 |
status | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. |
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. |
priority | S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. |
subject | SΣ | 0..1 | Reference(ANC Patient) | The patient or group present at the encounter |
episodeOfCare | SΣ | 0..* | Reference(CPGCase) | Episode(s) of care that this encounter should be recorded against |
basedOn | S | 0..* | Reference(ANC ServiceRequest) | The ServiceRequest that initiated this encounter |
participant | SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. |
period | S | 0..1 | Period | Period of time during the encounter that the participant participated |
individual | SΣ | 0..1 | Reference(ANC Practitioner | ANC PractitionerRole) | Persons involved in the encounter other than the patient |
period | S | 0..1 | Period | The start and end time of the encounter |
start | SΣC | 1..1 | dateTime | Contact date |
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) |
reasonCode | SΣ | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) |
diagnosis | SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
condition | SΣ | 1..1 | Reference(ANC Condition | ANC Procedure) | The diagnosis or procedure relevant to the encounter |
use | S | 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. |
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) |
location | S | 0..* | BackboneElement | List of locations where the patient has been |
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
location | S | 1..1 | Reference(ANC Location) | Location the encounter takes place |
serviceProvider | S | 0..1 | Reference(ANC Organization) | The organization (facility) responsible for this encounter |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type from the FHIR Standard | |
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | |
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG | |
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role 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().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() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints | ||||
---|---|---|---|---|---|---|---|---|
Encounter | 0..* | ANCBaseEncounter | 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: CommonLanguages (preferred): A human language.
| |||||
text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
contained | 0..* | Resource | Contained, inline Resources | |||||
Slices for extension | 1..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
statusReason | S | 0..1 | CodeableConcept | Reason for current status URL: http://hl7.org/fhir/StructureDefinition/request-statusReason Binding Description (No ValueSet): (example): Codes identifying the reason for the current state of an event. | ||||
contactNumber | 1..1 | Quantity | ANC contact number URL: http://fhir.org/guides/who/anc-cds/StructureDefinition/contactnumber | |||||
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
identifier | SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
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 | ?!SΣ | 1..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 | SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
value | SΣ | 1..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 | ?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
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 | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified status | |||||
class | SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. | ||||
classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
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 | ||||
class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
period | 1..1 | Period | The time that the episode was in the specified class | |||||
type | SΣ | 1..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
priority | S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | ||||
subject | SΣ | 0..1 | Reference(ANC Patient) | The patient or group present at the encounter | ||||
episodeOfCare | SΣ | 0..* | Reference(CPGCase) | Episode(s) of care that this encounter should be recorded against | ||||
basedOn | S | 0..* | Reference(ANC ServiceRequest) | The ServiceRequest that initiated this encounter | ||||
participant | SΣ | 0..* | BackboneElement | List of participants involved in the 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 | ||||
type | SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
period | S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
individual | SΣ | 0..1 | Reference(ANC Practitioner | ANC PractitionerRole) | Persons involved in the encounter other than the patient | ||||
appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
period | S | 0..1 | Period | The start and end time of the encounter | ||||
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 | Contact date | ||||
end | ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
length | S | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | ||||
reasonCode | SΣ | 1..1 | CodeableConcept | Reason for coming to facility Binding: Reason for coming to facility Choices Grouper (required) | ||||
reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
diagnosis | SΣ | 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 | SΣ | 1..1 | Reference(ANC Condition | ANC Procedure) | The diagnosis or procedure relevant to the encounter | ||||
use | S | 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. | ||||
rank | S | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | ||||
account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
hospitalization | 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 | 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. | |||||
dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
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 | S | 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 | S | 1..1 | Reference(ANC Location) | Location the encounter takes place | ||||
status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the 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. | |||||
period | 0..1 | Period | Time period during which the patient was present at the location | |||||
serviceProvider | S | 0..1 | Reference(ANC Organization) | The organization (facility) responsible for this encounter | ||||
partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
Documentation for this format |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages from the FHIR Standard | ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
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.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | required | ReasonforcomingtofacilityChoicesGrouperhttp://fhir.org/guides/who/anc-cds/ValueSet/anc-b5-de1-choices-grouper from this IG | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.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|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type 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().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 ANCBaseEncounter
Other representations of profile: CSV, Excel, Schematron