Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020
0.9.0 - CI Build
Nictiz FHIR NL R4 Zib2020 - Local Development build (v0.9.0). See the Directory of published versions
| Official URL: http://nictiz.nl/fhir/StructureDefinition/zib-Encounter | Version: 0.9.0 | |||
| Draft as of 2023-10-17 | Computable Name: ZibEncounter | |||
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. |
||||
A contact is 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.
Contacts can be visits to the general practitioner or other practices, home visits, admissions (in hospitals, nursing homes or care homes, psychiatric institutions or convalescent homes) or other relevant contacts. This includes past and future contacts.
This Encounter resource represents the Dutch zib (‘Zorginformatiebouwsteen’, i.e. Health and Care Information Model) Encounter v4.0.1 (2020) and zib HealthProfessional v3.5 (2020).
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
| Path | Conformance | ValueSet |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.participant:healthProfessional.type | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 |
| Encounter.hospitalization.admitSource | extensible | http://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 | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Encounter | 0..* | Encounter | This is an abstract profile. Child profiles: NlcoreEncounter Encounter | |
  implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
 class | Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. |
  Slices for participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() |
   participant:All Slices | Content/Rules for all slices | |||
  modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
  participant:healthProfessional | Σ | 0..* | BackboneElement | List of participants involved in the encounter |
  modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 (extensible) |
  individual | Σ | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | ContactWith |
| Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| reasonCode:deviatingResult | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
 commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
 url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | CommentContactReason | |
| text | Σ | 0..1 | string | DeviatingResult |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() |
| reasonReference:All Slices | Content/Rules for all slices | |||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | CommentContactReason | |
 reasonReference:problem | Σ | 0..* | Reference(zib Problem) | Problem |
| reasonReference:procedure | Σ | 0..* | Reference(zib Procedure event) | Procedure |
 location | 0..1 | BackboneElement | List of locations where the patient has been | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 location | 1..1 | Reference(Location | zib HealthcareProvider) | Location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.participant:healthProfessional.type | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 |
| Encounter.reasonCode | preferred | EncounterReasonCodes |
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | Encounter | This is an abstract profile. Child profiles: NlcoreEncounter Encounter | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
 extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
| status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
| serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| Slices for participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||
| participant:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| participant:healthProfessional | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 (extensible) | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | ContactWith | ||||
| appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period | 0..1 | Period | The start and end time of the encounter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDateTime | ||||
| end | ΣC | 0..1 | dateTime | EndDateTime | ||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonCode:deviatingResult | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | CommentContactReason | |||||
| text | Σ | 0..1 | string | DeviatingResult | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | CommentContactReason | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 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). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonReference:problem | Σ | 0..* | Reference(zib Problem) | Problem | ||||
| reasonReference:procedure | Σ | 0..* | Reference(zib Procedure event) | Procedure | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | 0..1 | CodeableConcept | Origin Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000 (extensible) | |||||
| reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition | 0..1 | CodeableConcept | Destination Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 (extensible) | |||||
| location | 0..1 | BackboneElement | List of locations where the patient has been | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | 1..1 | Reference(Location | zib HealthcareProvider) | Location | |||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | Encounter | This is an abstract profile. Child profiles: NlcoreEncounter Encounter | |
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | |
| class | 1..1 | Coding | ContactType Binding: ActEncounterCode (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | |
| Slices for participant | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | |
| participant:healthProfessional | 0..* | BackboneElement | List of participants involved in the encounter | |
| type | 0..1 | CodeableConcept | HealthProfessionalRole Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 (extensible) | |
| individual | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | ContactWith | |
| period | ||||
| start | 0..1 | dateTime | StartDateTime | |
| end | 0..1 | dateTime | EndDateTime | |
| Slices for reasonCode | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding | |
| reasonCode:deviatingResult | 0..* | CodeableConcept | Coded reason the encounter takes place | |
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| value[x] | 0..1 | string | CommentContactReason | |
| coding | 0..0 | |||
| text | 0..1 | string | DeviatingResult | |
| Slices for reasonReference | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() | |
| reasonReference:All Slices | Content/Rules for all slices | |||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| value[x] | 0..1 | string | CommentContactReason | |
| reasonReference:problem | 0..* | Reference(zib Problem) | Problem | |
| reasonReference:procedure | 0..* | Reference(zib Procedure event) | Procedure | |
| hospitalization | ||||
| admitSource | 0..1 | CodeableConcept | Origin Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000 (extensible) | |
| dischargeDisposition | 0..1 | CodeableConcept | Destination Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 (extensible) | |
| location | 0..1 | BackboneElement | List of locations where the patient has been | |
| location | 1..1 | Reference(Location | zib HealthcareProvider) | Location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.participant:healthProfessional.type | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 |
| Encounter.hospitalization.admitSource | extensible | http://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 | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Encounter | 0..* | Encounter | This is an abstract profile. Child profiles: NlcoreEncounter Encounter | |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. |
| class | Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. |
| Slices for participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() |
| participant:All Slices | Content/Rules for all slices | |||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| participant:healthProfessional | Σ | 0..* | BackboneElement | List of participants involved in the encounter |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| type | Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 (extensible) |
| individual | Σ | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | ContactWith |
| Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| reasonCode:deviatingResult | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. |
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | CommentContactReason | |
| text | Σ | 0..1 | string | DeviatingResult |
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() |
| reasonReference:All Slices | Content/Rules for all slices | |||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |
| value[x] | 0..1 | string | CommentContactReason | |
| reasonReference:problem | Σ | 0..* | Reference(zib Problem) | Problem |
| reasonReference:procedure | Σ | 0..* | Reference(zib Procedure event) | Procedure |
| location | 0..1 | BackboneElement | List of locations where the patient has been | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| location | 1..1 | Reference(Location | zib HealthcareProvider) | Location | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet |
| Encounter.status | required | EncounterStatus |
| Encounter.class | extensible | ActEncounterCode |
| Encounter.participant:healthProfessional.type | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 |
| Encounter.reasonCode | preferred | EncounterReasonCodes |
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodes |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Encounter | 0..* | Encounter | This is an abstract profile. Child profiles: NlcoreEncounter Encounter | |||||
| id | Σ | 0..1 | id | Logical id of this artifact | ||||
| meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
| contained | 0..* | Resource | Contained, inline Resources | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
| status | ?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | ||||
| statusHistory | 0..* | BackboneElement | List of past encounter statuses | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| status | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified status | |||||
| class | Σ | 1..1 | Coding | ContactType Binding: ActEncounterCode (extensible): Use ConceptMap ContactTypeCodeLijst-to-ActEncounterCode to translate terminology from the functional model to profile terminology in ValueSet ActEncounterCode. | ||||
| classHistory | 0..* | BackboneElement | List of past encounter classes | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| class | 1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter. | |||||
| period | 1..1 | Period | The time that the episode was in the specified class | |||||
| type | Σ | 0..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
| serviceType | Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
| priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | |||||
| subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
| episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
| basedOn | 0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
| Slices for participant | Σ | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by profile:individual.resolve() | ||||
| participant:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
| participant:healthProfessional | Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| type | Σ | 0..1 | CodeableConcept | HealthProfessionalRole Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 (extensible) | ||||
| period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
| individual | Σ | 0..1 | PatternZibHealthProfessionalReference(zib HealthProfessional PractitionerRole) | ContactWith | ||||
| appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
| period | 0..1 | Period | The start and end time of the encounter | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| start | ΣC | 0..1 | dateTime | StartDateTime | ||||
| end | ΣC | 0..1 | dateTime | EndDateTime | ||||
| length | 0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
| Slices for reasonCode | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Slice: Unordered, Open by exists:coding Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| reasonCode:deviatingResult | Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | CommentContactReason | |||||
| text | Σ | 0..1 | string | DeviatingResult | ||||
| Slices for reasonReference | Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) Slice: Unordered, Open by profile:resolve() | ||||
| reasonReference:All Slices | Content/Rules for all slices | |||||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| commentContactReason | 0..1 | string | Optional Extensions Element URL: http://nictiz.nl/fhir/StructureDefinition/ext-Comment | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| url | 1..1 | uri | "http://nictiz.nl/fhir/StructureDefinition/ext-Comment" | |||||
| value[x] | 0..1 | string | CommentContactReason | |||||
| reference | ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| type | Σ | 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). | ||||
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
| display | Σ | 0..1 | string | Text alternative for the resource | ||||
| reasonReference:problem | Σ | 0..* | Reference(zib Problem) | Problem | ||||
| reasonReference:procedure | Σ | 0..* | Reference(zib Procedure event) | Procedure | ||||
| diagnosis | Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| condition | Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
| use | 0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents. | |||||
| rank | 0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
| account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
| hospitalization | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
| origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
| admitSource | 0..1 | CodeableConcept | Origin Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.2--20200901000000 (extensible) | |||||
| reAdmission | 0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter. | |||||
| dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
| specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
| specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements. | |||||
| destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
| dischargeDisposition | 0..1 | CodeableConcept | Destination Binding: http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.15.1.3--20200901000000 (extensible) | |||||
| location | 0..1 | BackboneElement | List of locations where the patient has been | |||||
| id | 0..1 | string | Unique id for inter-element referencing | |||||
| extension | 0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| location | 1..1 | Reference(Location | zib HealthcareProvider) | Location | |||||
| status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
| physicalType | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location. | |||||
| period | 0..1 | Period | Time period during which the patient was present at the location | |||||
| serviceProvider | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
| partOf | 0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | ||||
| Encounter.language | preferred | CommonLanguages
| ||||
| Encounter.status | required | EncounterStatus | ||||
| Encounter.statusHistory.status | required | EncounterStatus | ||||
| Encounter.class | extensible | ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCode | ||||
| Encounter.type | example | EncounterType | ||||
| Encounter.serviceType | example | ServiceType | ||||
| Encounter.priority | example | ActPriority | ||||
| Encounter.participant.type | extensible | ParticipantType | ||||
| Encounter.participant:healthProfessional.type | extensible | http://decor.nictiz.nl/fhir/ValueSet/2.16.840.1.113883.2.4.3.11.60.40.2.17.1.5--20200901000000 | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodes | ||||
| Encounter.reasonCode:deviatingResult | preferred | EncounterReasonCodes | ||||
| Encounter.reasonReference.type | extensible | ResourceType | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
| Encounter.hospitalization.admitSource | extensible | http://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 | Hl7VSReAdmissionIndicator | ||||
| Encounter.hospitalization.dietPreference | example | Diet | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
| Encounter.hospitalization.dischargeDisposition | extensible | http://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 | EncounterLocationStatus | ||||
| Encounter.location.physicalType | example | LocationType |
| Id | Grade | Path(s) | Details | Requirements |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Encounter
Summary
Prohibited: 1 element
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron