HL7 Europe Imaging Study Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/oijauregui/ehdsimaging/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.eu/fhir/imaging-r5/StructureDefinition/EncounterEu | Version: 0.1.0-ballot | |||
| Standards status: Draft | Maturity Level: 1 | Computable Name: EncounterEu | ||
| Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License | ||||
A encounter profile for the EU.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    contained | 0..* | Resource | Contained, inline Resources | |
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |
|    modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | 
|    status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | 
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |
|    type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | 
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |
|    Slices for participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type Constraints: enc-1, enc-2 | 
|     participant:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      type | ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | 
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:admitter | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:discharger | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:referrer | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.status | required | EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0From the FHIR Standard | |
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type:participantCode | extensible | Pattern Value: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type:participantCode | extensible | Pattern Value: DIS http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type:participantCode | extensible | Pattern Value: REF http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) | |
| enc-1 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
| enc-2 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |
|    type | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | |
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |
|    Slices for participant | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type | |
|     participant:admitter | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |
|     participant:discharger | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |
|     participant:referrer | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |||||
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |||||
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |||||
|    modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
|    identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
|    status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
|    class | Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |||||
|    type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | ||||
|    serviceType | Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
|    subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | ||||
|    subjectStatus | 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||
|    episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
|    basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
|    careTeam | 0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |||||
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |||||
|    Slices for participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type Constraints: enc-1, enc-2 | ||||
|     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 | ΣC | 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 | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:admitter | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:discharger | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:referrer | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|    appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
|    virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
|    actualPeriod | 0..1 | Period | The actual start and end time of the encounter | |||||
|    plannedStartDate | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
|    plannedEndDate | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
|    length | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
|    reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
|     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 | ||||
|     use | Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
|     value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
|    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 | Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
|     use | 0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||
|    account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
|    dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
|    specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
|    specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
|    admission | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
|     origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
|     admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
|     reAdmission | 0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||
|     destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
|     dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
|    location | 0..* | BackboneElement | List of locations where the patient has been | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     location | 1..1 | Reference(Location) | Location the encounter takes place | |||||
|     status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
|     form | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
|     period | 0..1 | Period | Time period during which the patient was present at the location | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.language | required | AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Encounter.status | required | EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0From the FHIR Standard | |
| Encounter.class | preferred | EncounterClass http://terminology.hl7.org/ValueSet/encounter-class | |
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.serviceType | example | ServiceType http://hl7.org/fhir/ValueSet/service-type|5.0.0From the FHIR Standard | |
| Encounter.subjectStatus | example | EncounterSubjectStatus http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0From the FHIR Standard | |
| Encounter.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type:participantCode | extensible | Pattern Value: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type:participantCode | extensible | Pattern Value: DIS http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type:participantCode | extensible | Pattern Value: REF http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.reason.use | example | EncounterReasonUse http://hl7.org/fhir/ValueSet/encounter-reason-use|5.0.0From the FHIR Standard | |
| Encounter.reason.value | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason|5.0.0From the FHIR Standard | |
| Encounter.diagnosis.condition | example | ConditionProblemDiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code|5.0.0From the FHIR Standard | |
| Encounter.diagnosis.use | preferred | EncounterDiagnosisUse http://hl7.org/fhir/ValueSet/encounter-diagnosis-use|5.0.0From the FHIR Standard | |
| Encounter.dietPreference | example | EncounterDiet http://hl7.org/fhir/ValueSet/encounter-diet|5.0.0From the FHIR Standard | |
| Encounter.specialArrangement | preferred | SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements|5.0.0From the FHIR Standard | |
| Encounter.specialCourtesy | preferred | SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy|5.0.0From the FHIR Standard | |
| Encounter.admission.admitSource | preferred | AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source|5.0.0From the FHIR Standard | |
| Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092 | |
| Encounter.admission.dischargeDisposition | example | DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition|5.0.0From the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0From the FHIR Standard | |
| Encounter.location.form | example | LocationForm http://hl7.org/fhir/ValueSet/location-form|5.0.0From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) | |
| enc-1 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
| enc-2 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
| 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
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | 
|    contained | 0..* | Resource | Contained, inline Resources | |
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |
|    modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | 
|    status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | 
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |
|    type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | 
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |
|    Slices for participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type Constraints: enc-1, enc-2 | 
|     participant:All Slices | Content/Rules for all slices | |||
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      type | ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | 
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:admitter | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:discharger | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|     participant:referrer | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | 
|      modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | 
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | 
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | 
|        id | 0..1 | string | Unique id for inter-element referencing | |
|        extension | 0..* | Extension | Additional content defined by implementations | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         id | 0..1 | string | Unique id for inter-element referencing | |
|         extension | 0..* | Extension | Additional content defined by implementations | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         version | 0..1 | string | Version of the system - if relevant | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
|         display | 0..1 | string | Representation defined by the system | |
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |
|        text | 0..1 | string | Plain text representation of the concept | |
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | 
|  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.status | required | EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0From the FHIR Standard | |
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type:participantCode | extensible | Pattern Value: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type:participantCode | extensible | Pattern Value: DIS http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type:participantCode | extensible | Pattern Value: REF http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) | |
| enc-1 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
| enc-2 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() | 
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | 
|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |
|    type | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | |
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |
|    Slices for participant | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type | |
|     participant:admitter | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |
|     participant:discharger | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |
|     participant:referrer | 0..* | BackboneElement | List of participants involved in the encounter | |
|      Slices for type | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding | |
|       type:participantCode | 1..1 | CodeableConcept | Role of participant in encounter Required Pattern: At least the following | |
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |
|  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:   | ||||
|---|---|---|---|---|---|---|---|---|
|   Encounter | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
|    id | Σ | 0..1 | id | Logical id of this artifact | ||||
|    meta | Σ | 0..1 | Meta | Metadata about the resource | ||||
|    implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
|    language | 0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language 
 | |||||
|    text | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
|    contained | 0..* | Resource | Contained, inline Resources | |||||
|    Slices for extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
|     extension:note | 0..1 | Annotation | Additional notes that apply to this resource or element. URL: http://hl7.org/fhir/StructureDefinition/note | |||||
|     extension:legalStatus | 0..1 | CodeableConcept | Encounter: Legal Status URL: http://hl7.eu/fhir/StructureDefinition/encounter-legalStatus | |||||
|     extension:status-reason | 0..1 | CodeableConcept | Why was the status changed? URL: http://hl7.org/fhir/StructureDefinition/workflow-statusReason Binding: StatusReasonValueSet (example) | |||||
|    modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored | ||||
|    identifier | Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
|    status | ?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
|    class | Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: Encounter class (preferred): Classification of the encounter. | ||||
|    priority | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: x_EncounterAdmissionUrgency (preferred) | |||||
|    type | Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: ActEncounterCode (preferred) | ||||
|    serviceType | Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
|    subject | Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | ||||
|    subjectStatus | 0..1 | CodeableConcept | The current status of the subject in relation to the Encounter Binding: EncounterSubjectStatus (example): Current status of the subject within the encounter. | |||||
|    episodeOfCare | Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
|    basedOn | 0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
|    careTeam | 0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
|    partOf | 0..1 | Reference(Encounter: EU Encounter) | Another Encounter this encounter is part of | |||||
|    serviceProvider | 0..1 | Reference(Organization (EU base)) | The organization (facility) responsible for this encounter | |||||
|    Slices for participant | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Slice: Unordered, Open by value:type Constraints: enc-1, enc-2 | ||||
|     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 | ΣC | 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 | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:admitter | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: ADM | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:discharger | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: DIS | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|     participant:referrer | ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
|      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 | ||||
|      Slices for type | ΣC | 1..* | CodeableConcept | Role of participant in encounter Slice: Unordered, Open by value:coding Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
|       type:participantCode | ΣC | 1..1 | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. Required Pattern: At least the following | ||||
|        id | 0..1 | string | Unique id for inter-element referencing | |||||
|        extension | 0..* | Extension | Additional content defined by implementations | |||||
|        coding | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
|         id | 0..1 | string | Unique id for inter-element referencing | |||||
|         extension | 0..* | Extension | Additional content defined by implementations | |||||
|         system | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v3-ParticipationType | |||||
|         version | 0..1 | string | Version of the system - if relevant | |||||
|         code | 1..1 | code | Symbol in syntax defined by the system Fixed Value: REF | |||||
|         display | 0..1 | string | Representation defined by the system | |||||
|         userSelected | 0..1 | boolean | If this coding was chosen directly by the user | |||||
|        text | 0..1 | string | Plain text representation of the concept | |||||
|      period | 0..1 | Period | Period of time during the encounter that the participant participated | |||||
|      actor | ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
|    appointment | Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
|    virtualService | 0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
|    actualPeriod | 0..1 | Period | The actual start and end time of the encounter | |||||
|    plannedStartDate | 0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
|    plannedEndDate | 0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
|    length | 0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
|    reason | Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
|     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 | ||||
|     use | Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
|     value | Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
|    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 | Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
|     use | 0..* | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: EncounterDiagnosisUse (preferred): The type of diagnosis this condition represents. | |||||
|    account | 0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
|    dietPreference | 0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
|    specialArrangement | 0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
|    specialCourtesy | 0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
|    admission | 0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     preAdmissionIdentifier | 0..1 | Identifier | Pre-admission identifier | |||||
|     origin | 0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
|     admitSource | 0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
|     reAdmission | 0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this admission encounter. | |||||
|     destination | 0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
|     dischargeDisposition | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
|    location | 0..* | BackboneElement | List of locations where the patient has been | |||||
|     id | 0..1 | string | Unique id for inter-element referencing | |||||
|     extension | 0..* | Extension | Additional content defined by implementations | |||||
|     modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
|     location | 1..1 | Reference(Location) | Location the encounter takes place | |||||
|     status | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
|     form | 0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
|     period | 0..1 | Period | Time period during which the patient was present at the location | |||||
|  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.language | required | AllLanguages http://hl7.org/fhir/ValueSet/all-languages|5.0.0From the FHIR Standard | |
| Encounter.status | required | EncounterStatus http://hl7.org/fhir/ValueSet/encounter-status|5.0.0From the FHIR Standard | |
| Encounter.class | preferred | EncounterClass http://terminology.hl7.org/ValueSet/encounter-class | |
| Encounter.priority | preferred | XEncounterAdmissionUrgency http://terminology.hl7.org/ValueSet/v3-xEncounterAdmissionUrgency | |
| Encounter.type | preferred | ActEncounterCode http://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.serviceType | example | ServiceType http://hl7.org/fhir/ValueSet/service-type|5.0.0From the FHIR Standard | |
| Encounter.subjectStatus | example | EncounterSubjectStatus http://hl7.org/fhir/ValueSet/encounter-subject-status|5.0.0From the FHIR Standard | |
| Encounter.participant.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:admitter.type:participantCode | extensible | Pattern Value: ADM http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:discharger.type:participantCode | extensible | Pattern Value: DIS http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type | extensible | ParticipantType http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.participant:referrer.type:participantCode | extensible | Pattern Value: REF http://hl7.org/fhir/ValueSet/encounter-participant-type|5.0.0From the FHIR Standard | |
| Encounter.reason.use | example | EncounterReasonUse http://hl7.org/fhir/ValueSet/encounter-reason-use|5.0.0From the FHIR Standard | |
| Encounter.reason.value | preferred | EncounterReasonCodes http://hl7.org/fhir/ValueSet/encounter-reason|5.0.0From the FHIR Standard | |
| Encounter.diagnosis.condition | example | ConditionProblemDiagnosisCodes http://hl7.org/fhir/ValueSet/condition-code|5.0.0From the FHIR Standard | |
| Encounter.diagnosis.use | preferred | EncounterDiagnosisUse http://hl7.org/fhir/ValueSet/encounter-diagnosis-use|5.0.0From the FHIR Standard | |
| Encounter.dietPreference | example | EncounterDiet http://hl7.org/fhir/ValueSet/encounter-diet|5.0.0From the FHIR Standard | |
| Encounter.specialArrangement | preferred | SpecialArrangements http://hl7.org/fhir/ValueSet/encounter-special-arrangements|5.0.0From the FHIR Standard | |
| Encounter.specialCourtesy | preferred | SpecialCourtesy http://hl7.org/fhir/ValueSet/encounter-special-courtesy|5.0.0From the FHIR Standard | |
| Encounter.admission.admitSource | preferred | AdmitSource http://hl7.org/fhir/ValueSet/encounter-admit-source|5.0.0From the FHIR Standard | |
| Encounter.admission.reAdmission | example | Hl7VSReAdmissionIndicator http://terminology.hl7.org/ValueSet/v2-0092 | |
| Encounter.admission.dischargeDisposition | example | DischargeDisposition http://hl7.org/fhir/ValueSet/encounter-discharge-disposition|5.0.0From the FHIR Standard | |
| Encounter.location.status | required | EncounterLocationStatus http://hl7.org/fhir/ValueSet/encounter-location-status|5.0.0From the FHIR Standard | |
| Encounter.location.form | example | LocationForm http://hl7.org/fhir/ValueSet/location-form|5.0.0From 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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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()) | |
| enc-1 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type must be provided when no explicit actor is specified : actor.exists() or type.exists() | |
| enc-2 | error | Encounter.participant, Encounter.participant:admitter, Encounter.participant:discharger, Encounter.participant:referrer | A type cannot be provided for a patient or group participant : actor.exists(resolve() is Patient or resolve() is Group) implies type.exists().not() | |
| 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
Mandatory: 0 element(6 nested mandatory elements)
Structures
This structure refers to these other structures:
Extensions
This structure refers to these extensions:
Slices
This structure defines the following Slices:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron