Advance Care Planning (PZP)
1.0.0-rc1 - trial-use
This page is part of the Advance Care Planning (PZP) (v1.0.0-rc1: Release 1) based on FHIR (HL7® FHIR® Standard) R4. No current official version has been published yet. For a full list of available versions, see the Directory of published versions
| Official URL: https://api.iknl.nl/docs/pzp/r4/StructureDefinition/ACP-Encounter | Version: 1.0.0-rc1 | |||
| Draft as of 2025-10-30 | Computable Name: ACPEncounter | |||
Copyright/Legal: Copyright and related rights waived via CC0, https://creativecommons.org/publicdomain/zero/1.0/. This does not apply to information from third parties, for example a medical terminology system. The implementer alone is responsible for identifying and obtaining any necessary licenses or authorizations to utilize third party IP in connection with the specification or otherwise. |
||||
Any interaction, regardless of the situation, between a patient and the healthcare provider, in which the healthcare provider has primary responsibility for diagnosing, evaluating and treating the patient’s condition and informing the patient. These can be visits, appointments or non face-to-face interactions. Based on nl-core-Encounter and HCIM Encounter.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||
![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||||
![]() ![]() |
OΣC | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter Constraints: ref-1
| ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
ΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() Constraints: ref-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(nl core Problem) | Problem Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣC | 0..* | Reference(nl core Procedure event) | Procedure Constraints: ref-1
| ||||||
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location Constraints: ref-1 | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | |
| Encounter.participant:healthProfessional.type | extensible | ZorgverlenerRolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000|2020-09-01T00:00:00 | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | |
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From 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 | Encounter.implicitRules, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.individual, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonReference, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.modifierExtension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason, Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ref-1 | error | Encounter.subject, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from NlcoreEncounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
1..1 | Coding | ContactType | |||||||
![]() ![]() |
O | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter
| ||||||
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
O | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith | |||||||
![]() ![]() ![]() |
O | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient | |||||||
![]() ![]() |
||||||||||
![]() ![]() ![]() |
O | 0..1 | dateTime | StartDateTime
| ||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded reason the encounter takes place | |||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | ExtComment | Optional Extensions Element
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | ExtComment | Optional Extensions Element
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
O | 0..* | Reference(nl core Procedure event) | Procedure
| ||||||
Documentation for this format | ||||||||||
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||
![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||||
![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified status Constraints: per-1 | ||||||
![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||||
![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified class Constraints: per-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||||
![]() ![]() |
OΣC | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter Constraints: ref-1
| ||||||
![]() ![]() |
ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter Constraints: ref-1 | ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() |
ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..1 | Period | The start and end time of the encounter Constraints: per-1 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
OΣC | 0..1 | dateTime | StartDateTime
| ||||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDateTime | ||||||
![]() ![]() |
C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) Constraints: qty-3, drt-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | DeviatingResult | ||||||
![]() ![]() |
ΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() Constraints: ref-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(nl core Problem) | Problem Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣC | 0..* | Reference(nl core Procedure event) | Procedure Constraints: ref-1
| ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter Constraints: ref-1 | ||||||
![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||||
![]() ![]() |
C | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter Constraints: ref-1 | ||||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (2020-09-01T00:00:00) (extensible): From where the patient was admitted. | |||||||
![]() ![]() ![]() |
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: Hl7VSReAdmissionIndicator (2.0.0) (example): The reason for re-admission of this hospitalization encounter. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (2020-09-01T00:00:00) (extensible): Discharge Disposition. | |||||||
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||
![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() |
C | 0..1 | Period | Time period during which the patient was present at the location Constraints: per-1 | ||||||
![]() ![]() |
C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of Constraints: ref-1 | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | ||||
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1From the FHIR Standard | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1From the FHIR Standard | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0 | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1From the FHIR Standard | ||||
| Encounter.participant:healthProfessional.type | extensible | ZorgverlenerRolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.participant:contactPerson.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1From the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | ||||
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | ||||
| Encounter.reasonReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | extensible | HerkomstCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092|2.0.0 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | BestemmingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1From 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() | |
| drt-1 | error | Encounter.length | There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists()) | |
| ele-1 | error | Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.period, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.type, Encounter.participant:contactPerson.period, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonCode:deviatingResult.text, Encounter.reasonReference, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference.type, Encounter.reasonReference.identifier, Encounter.reasonReference.display, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Encounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.period.extension, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.period, Encounter.participant:contactPerson.period, Encounter.period, Encounter.location.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| qty-3 | error | Encounter.length | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOf | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from NlcoreEncounter
Summary
Structures
This structure refers to these other structures:
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||
![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||||
![]() ![]() |
OΣC | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter Constraints: ref-1
| ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
ΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() Constraints: ref-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(nl core Problem) | Problem Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣC | 0..* | Reference(nl core Procedure event) | Procedure Constraints: ref-1
| ||||||
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location Constraints: ref-1 | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI |
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | |
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | |
| Encounter.participant:healthProfessional.type | extensible | ZorgverlenerRolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000|2020-09-01T00:00:00 | |
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | |
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From 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 | Encounter.implicitRules, Encounter.modifierExtension, Encounter.status, Encounter.class, Encounter.subject, Encounter.participant, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.individual, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonReference, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location, Encounter.location.modifierExtension, Encounter.location.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Encounter.modifierExtension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.modifierExtension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason, Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ref-1 | error | Encounter.subject, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
Differential View
This structure is derived from NlcoreEncounter
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
1..1 | Coding | ContactType | |||||||
![]() ![]() |
O | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter
| ||||||
![]() ![]() |
0..* | BackboneElement | List of participants involved in the encounter | |||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
O | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith | |||||||
![]() ![]() ![]() |
O | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient | |||||||
![]() ![]() |
||||||||||
![]() ![]() ![]() |
O | 0..1 | dateTime | StartDateTime
| ||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Coded reason the encounter takes place | |||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | ExtComment | Optional Extensions Element
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | |||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
O | 0..1 | ExtComment | Optional Extensions Element
| ||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() |
O | 0..* | Reference(nl core Procedure event) | Procedure
| ||||||
Documentation for this format | ||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | NlcoreEncounter | Encounter | |||||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||
![]() ![]() |
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 | |||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||||
![]() ![]() |
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||||
![]() ![]() |
0..* | BackboneElement | List of past encounter statuses | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||||
![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified status Constraints: per-1 | ||||||
![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (3.0.0) (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||||
![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (3.0.0) (extensible): Classification of the encounter. | |||||||
![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified class Constraints: per-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||||
![]() ![]() |
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||||
![]() ![]() |
OΣC | 0..1 | Reference(Patient(1.0.0-rc1)) | The patient or group present at the encounter Constraints: ref-1
| ||||||
![]() ![]() |
ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter Constraints: ref-1 | ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (2020-09-01T00:00:00) (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(HealthProfessional PractitionerRole(1.0.0-rc1)) | ContactWith Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣ | 0..* | BackboneElement | List of participants involved in the encounter
| ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||||
![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated Constraints: per-1 | ||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(ContactPerson(1.0.0-rc1)) | Persons involved in the encounter other than the patient Constraints: ref-1 | ||||||
![]() ![]() |
ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..1 | Period | The start and end time of the encounter Constraints: per-1 | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
OΣC | 0..1 | dateTime | StartDateTime
| ||||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDateTime | ||||||
![]() ![]() |
C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) Constraints: qty-3, drt-1 | ||||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | DeviatingResult | ||||||
![]() ![]() |
ΣC | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() Constraints: ref-1 | ||||||
![]() ![]() ![]() |
Content/Rules for all slices | |||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() |
O | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment Constraints: ext-1
| ||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | CommentContactReason | |||||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(nl core Problem) | Problem Constraints: ref-1 | ||||||
![]() ![]() ![]() |
OΣC | 0..* | Reference(nl core Procedure event) | Procedure Constraints: ref-1
| ||||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter Constraints: ref-1 | ||||||
![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() |
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||||
![]() ![]() |
C | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter Constraints: ref-1 | ||||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (2020-09-01T00:00:00) (extensible): From where the patient was admitted. | |||||||
![]() ![]() ![]() |
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: Hl7VSReAdmissionIndicator (2.0.0) (example): The reason for re-admission of this hospitalization encounter. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||||
![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (2020-09-01T00:00:00) (extensible): Discharge Disposition. | |||||||
![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||
![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location Constraints: ref-1 | ||||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||||
![]() ![]() ![]() |
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. | |||||||
![]() ![]() ![]() |
C | 0..1 | Period | Time period during which the patient was present at the location Constraints: per-1 | ||||||
![]() ![]() |
C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter Constraints: ref-1 | ||||||
![]() ![]() |
C | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of Constraints: ref-1 | ||||||
Documentation for this format | ||||||||||
| Path | Conformance | ValueSet | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages|4.0.1From the FHIR Standard
| ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard | ||||
| Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode|3.0.0 | ||||
| Encounter.type | example | EncounterTypehttp://hl7.org/fhir/ValueSet/encounter-type|4.0.1From the FHIR Standard | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type|4.0.1From the FHIR Standard | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0 | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1From the FHIR Standard | ||||
| Encounter.participant:healthProfessional.type | extensible | ZorgverlenerRolCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.participant:contactPerson.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type|4.0.1From the FHIR Standard | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | ||||
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason|4.0.1From the FHIR Standard | ||||
| Encounter.reasonReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types|4.0.1From the FHIR Standard | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.admitSource | extensible | HerkomstCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092|2.0.0 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements|4.0.1From the FHIR Standard | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | BestemmingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000|2020-09-01T00:00:00 | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type|4.0.1From 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() | |
| drt-1 | error | Encounter.length | There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM. : code.exists() implies ((system = %ucum) and value.exists()) | |
| ele-1 | error | Encounter.meta, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.extension, Encounter.modifierExtension, Encounter.identifier, Encounter.status, Encounter.statusHistory, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.statusHistory.status, Encounter.statusHistory.period, Encounter.class, Encounter.classHistory, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.classHistory.class, Encounter.classHistory.period, Encounter.type, Encounter.serviceType, Encounter.priority, Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.individual, Encounter.participant:healthProfessional, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:healthProfessional.type, Encounter.participant:healthProfessional.period, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.participant:contactPerson.type, Encounter.participant:contactPerson.period, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.period, Encounter.period.extension, Encounter.period.start, Encounter.period.end, Encounter.length, Encounter.reasonCode, Encounter.reasonCode:deviatingResult, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason.value[x], Encounter.reasonCode:deviatingResult.text, Encounter.reasonReference, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.reasonReference.extension:commentContactReason.value[x], Encounter.reasonReference.reference, Encounter.reasonReference.type, Encounter.reasonReference.identifier, Encounter.reasonReference.display, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.use, Encounter.diagnosis.rank, Encounter.account, Encounter.hospitalization, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.hospitalization.preAdmissionIdentifier, Encounter.hospitalization.origin, Encounter.hospitalization.admitSource, Encounter.hospitalization.reAdmission, Encounter.hospitalization.dietPreference, Encounter.hospitalization.specialCourtesy, Encounter.hospitalization.specialArrangement, Encounter.hospitalization.destination, Encounter.hospitalization.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.status, Encounter.location.physicalType, Encounter.location.period, Encounter.serviceProvider, Encounter.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | Encounter.extension, Encounter.modifierExtension, Encounter.statusHistory.extension, Encounter.statusHistory.modifierExtension, Encounter.classHistory.extension, Encounter.classHistory.modifierExtension, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant:healthProfessional.extension, Encounter.participant:healthProfessional.modifierExtension, Encounter.participant:contactPerson.extension, Encounter.participant:contactPerson.modifierExtension, Encounter.period.extension, Encounter.reasonCode:deviatingResult.extension, Encounter.reasonCode:deviatingResult.extension:commentContactReason, Encounter.reasonCode:deviatingResult.extension:commentContactReason.extension, Encounter.reasonReference.extension, Encounter.reasonReference.extension:commentContactReason, Encounter.reasonReference.extension:commentContactReason.extension, Encounter.diagnosis.extension, Encounter.diagnosis.modifierExtension, Encounter.hospitalization.extension, Encounter.hospitalization.modifierExtension, Encounter.location.extension, Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| per-1 | error | Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.period, Encounter.participant:contactPerson.period, Encounter.period, Encounter.location.period | If present, start SHALL have a lower value than end : start.hasValue().not() or end.hasValue().not() or (start <= end) | |
| qty-3 | error | Encounter.length | If a code for the unit is present, the system SHALL also be present : code.empty() or system.exists() | |
| ref-1 | error | Encounter.subject, Encounter.episodeOfCare, Encounter.basedOn, Encounter.participant.individual, Encounter.participant:healthProfessional.individual, Encounter.participant:contactPerson.individual, Encounter.appointment, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.diagnosis.condition, Encounter.account, Encounter.hospitalization.origin, Encounter.hospitalization.destination, Encounter.location.location, Encounter.serviceProvider, Encounter.partOf | SHALL have a contained resource if a local reference is provided : reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) |
This structure is derived from NlcoreEncounter
Summary
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron