PLUGIN
0.1.0-ci - ci-build
NL
PLUGIN - Local Development build (v0.1.0-ci) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: https://plugin.healthcare/fhir/StructureDefinition/plugin-encounter | Version: 0.1.0-ci | |||
Draft as of 2024-11-05 | Computable Name: PluginEncounter | |||
Copyright/Legal: Used by permission of the PLUGIN team, all rights reserved Creative Commons License |
Contactmoment tussen patiënt en zorgverlener. Een contact kan zowel klinisch ((dag)opname) als poliklinisch zijn.
In het geval dat een patiënt tijdens een opname meerdere contactmomenten heeft, bijvoorbeeld als een patiënt vanaf de SEH naar de afdeling wordt overgeplaatst, wordt gebruik gemaakt van een hoofd- en deelbezoeken. Deze worden aan elkaar gekoppeld m.b.v. het attribuut partOf. De API van Epic lijkt dit te ondersteunen?
Het attribuut class
kan gebruikt worden voor het type bezoek. In nl-core-Encounter is hier een waardenlijst aan gekoppeld: https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.zib2020@0.11.0-beta.1&filepath=package/ConceptMap-ContactTypeCodeLijst-to-ActEncounterCode.json. Vertaling naar/afstemming met de use-case AIOC moet nog plaatsvinden.
In release v6 (2023) van de ZiBs (ContactTypeCodelijst) zijn deze codes komen te vervallen en vervangen door SNOMED codes.
Voor AIOC is het nodig te weten via welke route een patient in het ziekenhuis terecht kwam. De ValueSet hiervoor moet nog aangemaakt/gekoppeld worden.
Voor AIOC is het nodig te weten waar de patient na ontslag naartoe gaat. De ValueSet hiervoor moet nog aangemaakt/gekoppeld worden. Admit source, de 'preferred' value set, lijkt hiervoor geschikt?
In veel gevallen is het wenselijk om te achterhalen welk specialisme hoofdverantwoordelijk was voor een (deel)contact.
De route die hiervoor voor de hand ligt is participant > individual (PractitionerRole) > specialty
. De nl-core (0.11.0-beta.1) bevat een profiel op PractitionerRole dat (https://simplifier.net/resolve?scope=nictiz.fhir.nl.r4.zib2020@0.11.0-beta.1&filepath=package/ValueSet-SpecialismeCodelijsten-2.16.840.1.113883.2.4.3.11.60.121.11.22–20200901000000.json)
Aard van de betrokkenheid van een specialisme volgt dan via participant > type (admit/attend/discharge)
Alternatieven?
- serviceType
- serviceProvider
(Organization) met ValueSet voor Organization.type
- anders?
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NlcoreEncounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NlcoreEncounter | Encounter | |
![]() ![]() ![]() |
S | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
1..1 | Coding | ContactType Binding: ActEncounterCode (required) | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Specific type of service |
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | HealthProfessionalRole |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination |
![]() ![]() ![]() |
S | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.priority | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NlcoreEncounter | Encounter | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
?!SΣ | 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 (required) |
![]() ![]() ![]() |
SΣ | 1..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 (required) | |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
ΣN | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() |
ΣCN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Problem) | Problem ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Procedure event) | Procedure ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (extensible): From where the patient was admitted. |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): Discharge Disposition. |
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
SC | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
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 | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from 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 | |
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 |
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() | |
ref-1 | error | Encounter.subject, Encounter.participant:healthProfessional.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location, 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')) |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!SΣ | 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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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 per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
SΣ | 1..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 (required) | |||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣN | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() ![]() |
CN | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() ![]() |
ΣCN | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | Period | The start and end time of the encounter per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | StartDateTime | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDateTime | ||||
![]() ![]() ![]() |
C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) qty-3: If a code for the unit is present, the system SHALL also be present drt-1: 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. | ||||
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() ![]() |
ΣN | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | string | CommentContactReason | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | DeviatingResult | ||||
![]() ![]() ![]() |
ΣCN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 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). | ||||
![]() ![]() ![]() ![]() ![]() |
ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Problem) | Problem ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Procedure event) | Procedure ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (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: hl7VS-re-admissionIndicator (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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): Discharge Disposition. | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
SC | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages 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 | required | 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 | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from 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 | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.reasonReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from 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 | ||||
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 | extensible | BestemmingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 | ||||
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() | |
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 | **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() | |
per-1 | error | Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.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.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
Mandatory: 3 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Differential View
This structure is derived from NlcoreEncounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NlcoreEncounter | Encounter | |
![]() ![]() ![]() |
S | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
S | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + |
![]() ![]() ![]() |
1..1 | Coding | ContactType Binding: ActEncounterCode (required) | |
![]() ![]() ![]() |
S | 1..1 | CodeableConcept | Specific type of service |
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (required) | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter |
![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | HealthProfessionalRole |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination |
![]() ![]() ![]() |
S | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.priority | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | NlcoreEncounter | Encounter | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url |
![]() ![]() ![]() |
SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known |
![]() ![]() ![]() |
?!SΣ | 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 (required) |
![]() ![]() ![]() |
SΣ | 1..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 (required) | |
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
ΣN | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter. |
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() |
ΣCN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL |
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Problem) | Problem ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Procedure event) | Procedure ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (extensible): From where the patient was admitted. |
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): Discharge Disposition. |
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() |
SC | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | |
Encounter.class | required | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | |
Encounter.priority | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
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 | |
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | |
Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from 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 | |
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 |
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() | |
ref-1 | error | Encounter.subject, Encounter.participant:healthProfessional.individual, Encounter.reasonReference, Encounter.reasonReference:problem, Encounter.reasonReference:procedure, Encounter.location.location, 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')) |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
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 | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
SΣ | 1..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
?!SΣ | 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 | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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 per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (required) | ||||
![]() ![]() ![]() |
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
![]() ![]() ![]() ![]() |
C | 1..1 | Period | The time that the episode was in the specified class per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() |
SΣ | 1..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 (required) | |||||
![]() ![]() ![]() |
SΣC | 1..1 | Reference(Patient | nl core Patient) | The patient or group present at the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣN | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!ΣN | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() ![]() |
CN | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() ![]() |
ΣCN | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: ZorgverlenerRolCodelijst (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Period | Period of time during the encounter that the participant participated per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | PatternNlCoreHealthProfessionalReference(PractitionerSpecialty | nl core HealthProfessional PractitionerRole) | A reference from one resource to another ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
ΣC | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
C | 0..1 | Period | The start and end time of the encounter per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | StartDateTime | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | EndDateTime | ||||
![]() ![]() ![]() |
C | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) qty-3: If a code for the unit is present, the system SHALL also be present drt-1: 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. | ||||
![]() ![]() ![]() |
ΣN | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() ![]() ![]() |
ΣN | 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 | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | string | CommentContactReason | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | DeviatingResult | ||||
![]() ![]() ![]() |
ΣCN | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..1 | (Complex) | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 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). | ||||
![]() ![]() ![]() ![]() ![]() |
ΣN | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Problem) | Problem ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
ΣCN | 0..* | Reference(nl core Procedure event) | Procedure ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Origin Binding: HerkomstCodelijst (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: hl7VS-re-admissionIndicator (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 ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Destination Binding: BestemmingCodelijst (extensible): Discharge Disposition. | ||||
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
C | 1..1 | Reference(Location | nl core HealthcareProvider) | Location ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() |
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 per-1: If present, start SHALL have a lower value than end | ||||
![]() ![]() ![]() |
C | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() |
SC | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languages 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 | required | 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 | required | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from 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 | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.reasonReference.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from 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 | ||||
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 | extensible | BestemmingCodelijsthttp://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 | ||||
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() | |
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 | **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() | |
per-1 | error | Encounter.statusHistory.period, Encounter.classHistory.period, Encounter.participant.period, Encounter.participant:healthProfessional.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.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
Mandatory: 3 elements
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Other representations of profile: CSV, Excel, Schematron