Extensions for Using Data Elements from FHIR STU3 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/3.0/StructureDefinition/profile-Encounter | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R3_Encounter_R5 | ||
This cross-version profile allows STU3 Encounter content to be represented via FHIR R5 Encounter resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(5.0.0) | An interaction during which services are provided to the patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter statuses (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.statusHistory Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter classes (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.classHistory Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
0..1 | code | STU3: planned | arrived | triaged | in-progress | onleave | finished | cancelled + URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.status Binding: R3EncounterStatusForR5 (0.1.0) (required): Current state of the encounter Constraints: ext-1 | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required |
Encounter Status
|
📍5.0.0 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Encounter.implicitRules, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status | 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: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter(5.0.0) | An interaction during which services are provided to the patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Meta | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter statuses (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.statusHistory Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter classes (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.classHistory Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | STU3: planned | arrived | triaged | in-progress | onleave | finished | cancelled + URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.status Binding: R3EncounterStatusForR5 (0.1.0) (required): Current state of the encounter Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: EncounterClass (2.0.1) (preferred): Classification of the encounter. | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The patient ro group present at the encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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. | |||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: episodeOfCare additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The ReferralRequest that initiated this encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The custodian organization of this Encounter record additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.participant.period Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Persons involved in the encounter other than the patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: appointment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..1 | Period | The actual start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: The start and end time of the encounter additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.period Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
![]() ![]() |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
![]() ![]() |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | STU3: Ranking of the diagnosis (for each role type) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.diagnosis.rank Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) | STU3: Reason the encounter takes place (resource) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.diagnosis.condition Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: account additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Diet preferences reported by the patient (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Special courtesies (VIP, board member) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy Binding: SpecialCourtesy (preferred): Special courtesies Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Wheelchair, translator, stretcher, etc. (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement Binding: SpecialArrangements (preferred): Special arrangements Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | STU3: preAdmissionIdentifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The location from which the patient came before admission additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this admission encounter. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Location to which the patient is discharged additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: location additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.location.period Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible |
All Security Labels
|
📍5.0.0 | tx.fhir.org |
| Encounter.meta.tag | Base | example | Common Tags | 📍5.0.0 | FHIR Std. |
| Encounter.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Encounter.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Encounter.status | Base | required |
Encounter Status
|
📍5.0.0 | tx.fhir.org |
| Encounter.class | Base | preferred | Encounter class | 📍2.0.1 | THO v7.1 |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Encounter.type | Base | example | Encounter Type | 📍5.0.0 | FHIR Std. |
| Encounter.serviceType | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| Encounter.subject.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.subjectStatus | Base | example | Encounter Subject Status | 📍5.0.0 | FHIR Std. |
| Encounter.episodeOfCare.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.basedOn.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.partOf.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.serviceProvider.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.participant.type | Base | extensible |
Participant Type
|
📍5.0.0 | tx.fhir.org |
| Encounter.participant.actor.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.appointment.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.reason.use | Base | example | Encounter Reason Use | 📍5.0.0 | FHIR Std. |
| Encounter.reason.value | Base | preferred | Encounter Reason Codes | 📍5.0.0 | FHIR Std. |
| Encounter.diagnosis.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | Encounter Diagnosis Use | 📍5.0.0 | FHIR Std. |
| Encounter.account.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.dietPreference | Base | example | Diet | 📍5.0.0 | FHIR Std. |
| Encounter.specialArrangement | Base | preferred | Special Arrangements | 📍5.0.0 | FHIR Std. |
| Encounter.specialCourtesy | Base | preferred | Special Courtesy | 📍5.0.0 | FHIR Std. |
| Encounter.admission.preAdmissionIdentifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Encounter.admission.preAdmissionIdentifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Encounter.admission.origin.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.admission.admitSource | Base | preferred | Admit Source | 📍5.0.0 | FHIR Std. |
| Encounter.admission.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1 |
| Encounter.admission.destination.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.admission.dischargeDisposition | Base | example | Discharge Disposition | 📍5.0.0 | FHIR Std. |
| Encounter.location.location.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.location.status | Base | required | Encounter Location Status | 📍5.0.0 | FHIR Std. |
| Encounter.location.form | Base | example | Location Form | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Encounter.meta, Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.meta.versionId, Encounter.meta.lastUpdated, Encounter.meta.source, Encounter.meta.profile, Encounter.meta.security, Encounter.meta.tag, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.text.extension, Encounter.text.extension:text, Encounter.text.status, Encounter.text.div, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.priority, Encounter.type, Encounter.serviceType, Encounter.subject, Encounter.subject.extension, Encounter.subject.extension:subject, Encounter.subject.reference, Encounter.subject.type, Encounter.subject.identifier, Encounter.subject.display, Encounter.subjectStatus, Encounter.episodeOfCare, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.episodeOfCare.reference, Encounter.episodeOfCare.type, Encounter.episodeOfCare.identifier, Encounter.episodeOfCare.display, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.careTeam, Encounter.partOf, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.partOf.reference, Encounter.partOf.type, Encounter.partOf.identifier, Encounter.partOf.display, Encounter.serviceProvider, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.serviceProvider.reference, Encounter.serviceProvider.type, Encounter.serviceProvider.identifier, Encounter.serviceProvider.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.period.start, Encounter.participant.period.end, Encounter.participant.actor, Encounter.participant.actor.extension, Encounter.participant.actor.extension:individual, Encounter.participant.actor.reference, Encounter.participant.actor.type, Encounter.participant.actor.identifier, Encounter.participant.actor.display, Encounter.appointment, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.appointment.reference, Encounter.appointment.type, Encounter.appointment.identifier, Encounter.appointment.display, Encounter.virtualService, Encounter.actualPeriod, Encounter.actualPeriod.extension, Encounter.actualPeriod.extension:period, Encounter.actualPeriod.start, Encounter.actualPeriod.end, Encounter.plannedStartDate, Encounter.plannedEndDate, Encounter.length, Encounter.reason, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.use, Encounter.reason.value, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.concept, Encounter.diagnosis.condition.reference, Encounter.diagnosis.use, Encounter.account, Encounter.account.extension, Encounter.account.extension:account, Encounter.account.reference, Encounter.account.type, Encounter.account.identifier, Encounter.account.display, Encounter.dietPreference, Encounter.specialArrangement, Encounter.specialCourtesy, Encounter.admission, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier, Encounter.admission.preAdmissionIdentifier.extension, Encounter.admission.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.admission.preAdmissionIdentifier.use, Encounter.admission.preAdmissionIdentifier.type, Encounter.admission.preAdmissionIdentifier.system, Encounter.admission.preAdmissionIdentifier.value, Encounter.admission.preAdmissionIdentifier.period, Encounter.admission.preAdmissionIdentifier.assigner, Encounter.admission.origin, Encounter.admission.origin.extension, Encounter.admission.origin.extension:origin, Encounter.admission.origin.reference, Encounter.admission.origin.type, Encounter.admission.origin.identifier, Encounter.admission.origin.display, Encounter.admission.admitSource, Encounter.admission.reAdmission, Encounter.admission.destination, Encounter.admission.destination.extension, Encounter.admission.destination.extension:destination, Encounter.admission.destination.reference, Encounter.admission.destination.type, Encounter.admission.destination.identifier, Encounter.admission.destination.display, Encounter.admission.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.location.reference, Encounter.location.location.type, Encounter.location.location.identifier, Encounter.location.location.display, Encounter.location.status, Encounter.location.form, Encounter.location.period, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.location.period.start, Encounter.location.period.end | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified |
actor.exists() or type.exists()
|
| enc-2 | error | Encounter.participant | 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 | Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.text.extension, Encounter.text.extension:text, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.status.extension, Encounter.status.extension:status, Encounter.subject.extension, Encounter.subject.extension:subject, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.actor.extension, Encounter.participant.actor.extension:individual, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.actualPeriod.extension, Encounter.actualPeriod.extension:period, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.account.extension, Encounter.account.extension:account, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier.extension, Encounter.admission.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.admission.origin.extension, Encounter.admission.origin.extension:origin, Encounter.admission.destination.extension, Encounter.admission.destination.extension:destination, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.period.extension, Encounter.location.period.extension:period | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Encounter.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Encounter.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Encounter
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | Encounter(5.0.0) | An interaction during which services are provided to the patient | |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
0..* | Resource | Contained, inline Resources | |
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter statuses (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.statusHistory Constraints: ext-1 | |
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter classes (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.classHistory Constraints: ext-1 | |
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. |
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |
![]() ![]() ![]() ![]() |
0..1 | code | STU3: planned | arrived | triaged | in-progress | onleave | finished | cancelled + URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.status Binding: R3EncounterStatusForR5 (0.1.0) (required): Current state of the encounter Constraints: ext-1 | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.status | Base | required |
Encounter Status
|
📍5.0.0 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Encounter.implicitRules, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status, Encounter.status.extension, Encounter.status.extension:status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.status.extension, Encounter.status.extension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from Encounter
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
0..* | Encounter(5.0.0) | An interaction during which services are provided to the patient | |||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Meta | STU3: meta additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.meta Constraints: ext-1 | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Version specific identifier | ||||
![]() ![]() ![]() |
Σ | 0..1 | instant | When the resource version last changed | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Identifies where the resource comes from | ||||
![]() ![]() ![]() |
Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Security Labels applied to this resource Binding: AllSecurityLabels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() |
Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones". | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: AllLanguages (required): IETF language tag for a human language
| |||||
![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | (Complex) | STU3: text additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.text Constraints: ext-1 | |||||
![]() ![]() ![]() |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. | |||||
![]() ![]() ![]() |
C | 1..1 | xhtml | Limited xhtml content Constraints: txt-1, txt-2 | ||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter statuses (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.statusHistory Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..* | (Complex) | STU3: List of past encounter classes (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.classHistory Constraints: ext-1 | |||||
![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||
![]() ![]() |
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | Identifier | STU3: identifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.identifier Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() |
?!Σ | 1..1 | code | planned | in-progress | on-hold | discharged | completed | cancelled | discontinued | entered-in-error | unknown Binding: EncounterStatus (required): Current state of the encounter. | ||||
![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | code | STU3: planned | arrived | triaged | in-progress | onleave | finished | cancelled + URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.status Binding: R3EncounterStatusForR5 (0.1.0) (required): Current state of the encounter Constraints: ext-1 | |||||
![]() ![]() ![]() |
0..1 | code | Primitive value for code | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Classification of patient encounter context - e.g. Inpatient, outpatient Binding: EncounterClass (2.0.1) (preferred): Classification of the encounter. | ||||
![]() ![]() |
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (3.0.0) (example): Indicates the urgency of the encounter. | |||||
![]() ![]() |
Σ | 0..* | CodeableConcept | Specific type of encounter (e.g. e-mail consultation, surgical day-care, ...) Binding: EncounterType (example): A specific code indicating type of service provided | ||||
![]() ![]() |
Σ | 0..* | CodeableReference(HealthcareService) | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() |
Σ | 0..1 | Reference(Patient | Group) | The patient or group related to this encounter | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The patient ro group present at the encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
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. | |||||
![]() ![]() |
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: episodeOfCare additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(CarePlan | DeviceRequest | MedicationRequest | ServiceRequest) | The request that initiated this encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The ReferralRequest that initiated this encounter additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | Reference(CareTeam) | The group(s) that are allocated to participate in this encounter | |||||
![]() ![]() |
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: partOf additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The custodian organization of this Encounter record additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
ΣC | 0..* | BackboneElement | List of participants involved in the encounter Constraints: enc-1, enc-2 | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
ΣC | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() |
0..1 | Period | Period of time during the encounter that the participant participated | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.participant.period Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Reference(Patient | Group | RelatedPerson | Practitioner | PractitionerRole | Device | HealthcareService) | The individual, device, or service participating in the encounter | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Persons involved in the encounter other than the patient additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: appointment additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | VirtualServiceDetail | Connection details of a virtual service (e.g. conference call) | |||||
![]() ![]() |
0..1 | Period | The actual start and end time of the encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Period | STU3: The start and end time of the encounter additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.period Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
![]() ![]() |
0..1 | dateTime | The planned start date/time (or admission date) of the encounter | |||||
![]() ![]() |
0..1 | dateTime | The planned end date/time (or discharge date) of the encounter | |||||
![]() ![]() |
0..1 | Duration | Actual quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of medical reasons that are expected to be addressed during the episode of care | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | What the reason value should be used for/as Binding: EncounterReasonUse (example) | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(Condition | DiagnosticReport | Observation | ImmunizationRecommendation | Procedure) | Reason the encounter takes place (core or reference) Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. | ||||
![]() ![]() |
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | positiveInt | STU3: Ranking of the diagnosis (for each role type) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.diagnosis.rank Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
Σ | 0..* | CodeableReference(Condition) | The diagnosis relevant to the encounter Binding: ConditionProblemDiagnosisCodes (example) | ||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Reference(Cross-version Profile for STU3.Condition for use in FHIR R5(0.1.0) | Condition | Cross-version Profile for STU3.Procedure for use in FHIR R5(0.1.0) | Procedure) | STU3: Reason the encounter takes place (resource) additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.diagnosis.condition Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Reference to a concept (by class) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference() | Reference to a resource (by instance) | ||||
![]() ![]() ![]() |
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. | |||||
![]() ![]() |
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: account additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() |
0..* | CodeableConcept | Diet preferences reported by the patient Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. | |||||
![]() ![]() |
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc Binding: SpecialArrangements (preferred): Special arrangements. | |||||
![]() ![]() |
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies. | |||||
![]() ![]() |
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Diet preferences reported by the patient (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.dietPreference Binding: EncounterDiet (example): Medical, cultural or ethical food preferences to help with catering requirements. Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Special courtesies (VIP, board member) (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.specialCourtesy Binding: SpecialCourtesy (preferred): Special courtesies Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | STU3: Wheelchair, translator, stretcher, etc. (new) URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.specialArrangement Binding: SpecialArrangements (preferred): Special arrangements Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Identifier | STU3: preAdmissionIdentifier additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.hospitalization.preAdmissionIdentifier Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Description of identifier Binding: IdentifierTypeCodes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | The value that is unique Example General: 123456 | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Period | Time period when id is/was valid for use | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) | ||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: The location from which the patient came before admission additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Indicates that the patient is being re-admitted Binding: Hl7VSReAdmissionIndicator (3.0.0) (example): The reason for re-admission of this admission encounter. | |||||
![]() ![]() ![]() |
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: Location to which the patient is discharged additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | |||||
![]() ![]() |
0..* | BackboneElement | List of locations where the patient has been | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||
![]() ![]() ![]() |
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Resource) | STU3: location additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") - must be a resource in resources Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() |
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. | |||||
![]() ![]() ![]() |
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierarchy - bed, room, ward, virtual etc.) Binding: LocationForm (example): Physical form of the location. | |||||
![]() ![]() ![]() |
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Period | STU3: period additional types URL: http://hl7.org/fhir/3.0/StructureDefinition/extension-Encounter.location.period Constraints: ext-1 | |||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | Starting time with inclusive boundary | ||||
![]() ![]() ![]() ![]() |
ΣC | 0..1 | dateTime | End time with inclusive boundary, if not ongoing | ||||
Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| Encounter.meta.security | Base | extensible |
All Security Labels
|
📍5.0.0 | tx.fhir.org |
| Encounter.meta.tag | Base | example | Common Tags | 📍5.0.0 | FHIR Std. |
| Encounter.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| Encounter.text.status | Base | required | NarrativeStatus | 📍5.0.0 | FHIR Std. |
| Encounter.identifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Encounter.identifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Encounter.status | Base | required |
Encounter Status
|
📍5.0.0 | tx.fhir.org |
| Encounter.class | Base | preferred | Encounter class | 📍2.0.1 | THO v7.1 |
| Encounter.priority | Base | example | ActPriority | 📍3.0.0 | THO v7.1 |
| Encounter.type | Base | example | Encounter Type | 📍5.0.0 | FHIR Std. |
| Encounter.serviceType | Base | example | Service Type | 📍5.0.0 | FHIR Std. |
| Encounter.subject.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.subjectStatus | Base | example | Encounter Subject Status | 📍5.0.0 | FHIR Std. |
| Encounter.episodeOfCare.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.basedOn.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.partOf.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.serviceProvider.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.participant.type | Base | extensible |
Participant Type
|
📍5.0.0 | tx.fhir.org |
| Encounter.participant.actor.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.appointment.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.reason.use | Base | example | Encounter Reason Use | 📍5.0.0 | FHIR Std. |
| Encounter.reason.value | Base | preferred | Encounter Reason Codes | 📍5.0.0 | FHIR Std. |
| Encounter.diagnosis.condition | Base | example | Condition/Problem/Diagnosis Codes | 📍5.0.0 | FHIR Std. |
| Encounter.diagnosis.use | Base | preferred | Encounter Diagnosis Use | 📍5.0.0 | FHIR Std. |
| Encounter.account.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.dietPreference | Base | example | Diet | 📍5.0.0 | FHIR Std. |
| Encounter.specialArrangement | Base | preferred | Special Arrangements | 📍5.0.0 | FHIR Std. |
| Encounter.specialCourtesy | Base | preferred | Special Courtesy | 📍5.0.0 | FHIR Std. |
| Encounter.admission.preAdmissionIdentifier.use | Base | required | IdentifierUse | 📍5.0.0 | FHIR Std. |
| Encounter.admission.preAdmissionIdentifier.type | Base | extensible | Identifier Type Codes | 📍5.0.0 | FHIR Std. |
| Encounter.admission.origin.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.admission.admitSource | Base | preferred | Admit Source | 📍5.0.0 | FHIR Std. |
| Encounter.admission.reAdmission | Base | example | hl7VS-re-admissionIndicator | 📍3.0.0 | THO v7.1 |
| Encounter.admission.destination.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.admission.dischargeDisposition | Base | example | Discharge Disposition | 📍5.0.0 | FHIR Std. |
| Encounter.location.location.type | Base | extensible |
Resource Types
|
📍5.0.0 | tx.fhir.org |
| Encounter.location.status | Base | required | Encounter Location Status | 📍5.0.0 | FHIR Std. |
| Encounter.location.form | Base | example | Location Form | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| 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 | Encounter.meta, Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.meta.versionId, Encounter.meta.lastUpdated, Encounter.meta.source, Encounter.meta.profile, Encounter.meta.security, Encounter.meta.tag, Encounter.implicitRules, Encounter.language, Encounter.text, Encounter.text.extension, Encounter.text.extension:text, Encounter.text.status, Encounter.text.div, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.identifier.use, Encounter.identifier.type, Encounter.identifier.system, Encounter.identifier.value, Encounter.identifier.period, Encounter.identifier.assigner, Encounter.status, Encounter.status.extension, Encounter.status.extension:status, Encounter.class, Encounter.priority, Encounter.type, Encounter.serviceType, Encounter.subject, Encounter.subject.extension, Encounter.subject.extension:subject, Encounter.subject.reference, Encounter.subject.type, Encounter.subject.identifier, Encounter.subject.display, Encounter.subjectStatus, Encounter.episodeOfCare, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.episodeOfCare.reference, Encounter.episodeOfCare.type, Encounter.episodeOfCare.identifier, Encounter.episodeOfCare.display, Encounter.basedOn, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.basedOn.reference, Encounter.basedOn.type, Encounter.basedOn.identifier, Encounter.basedOn.display, Encounter.careTeam, Encounter.partOf, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.partOf.reference, Encounter.partOf.type, Encounter.partOf.identifier, Encounter.partOf.display, Encounter.serviceProvider, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.serviceProvider.reference, Encounter.serviceProvider.type, Encounter.serviceProvider.identifier, Encounter.serviceProvider.display, Encounter.participant, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.type, Encounter.participant.period, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.period.start, Encounter.participant.period.end, Encounter.participant.actor, Encounter.participant.actor.extension, Encounter.participant.actor.extension:individual, Encounter.participant.actor.reference, Encounter.participant.actor.type, Encounter.participant.actor.identifier, Encounter.participant.actor.display, Encounter.appointment, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.appointment.reference, Encounter.appointment.type, Encounter.appointment.identifier, Encounter.appointment.display, Encounter.virtualService, Encounter.actualPeriod, Encounter.actualPeriod.extension, Encounter.actualPeriod.extension:period, Encounter.actualPeriod.start, Encounter.actualPeriod.end, Encounter.plannedStartDate, Encounter.plannedEndDate, Encounter.length, Encounter.reason, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.reason.use, Encounter.reason.value, Encounter.diagnosis, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.diagnosis.condition.concept, Encounter.diagnosis.condition.reference, Encounter.diagnosis.use, Encounter.account, Encounter.account.extension, Encounter.account.extension:account, Encounter.account.reference, Encounter.account.type, Encounter.account.identifier, Encounter.account.display, Encounter.dietPreference, Encounter.specialArrangement, Encounter.specialCourtesy, Encounter.admission, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier, Encounter.admission.preAdmissionIdentifier.extension, Encounter.admission.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.admission.preAdmissionIdentifier.use, Encounter.admission.preAdmissionIdentifier.type, Encounter.admission.preAdmissionIdentifier.system, Encounter.admission.preAdmissionIdentifier.value, Encounter.admission.preAdmissionIdentifier.period, Encounter.admission.preAdmissionIdentifier.assigner, Encounter.admission.origin, Encounter.admission.origin.extension, Encounter.admission.origin.extension:origin, Encounter.admission.origin.reference, Encounter.admission.origin.type, Encounter.admission.origin.identifier, Encounter.admission.origin.display, Encounter.admission.admitSource, Encounter.admission.reAdmission, Encounter.admission.destination, Encounter.admission.destination.extension, Encounter.admission.destination.extension:destination, Encounter.admission.destination.reference, Encounter.admission.destination.type, Encounter.admission.destination.identifier, Encounter.admission.destination.display, Encounter.admission.dischargeDisposition, Encounter.location, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.location.reference, Encounter.location.location.type, Encounter.location.location.identifier, Encounter.location.location.display, Encounter.location.status, Encounter.location.form, Encounter.location.period, Encounter.location.period.extension, Encounter.location.period.extension:period, Encounter.location.period.start, Encounter.location.period.end | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| enc-1 | error | Encounter.participant | A type must be provided when no explicit actor is specified |
actor.exists() or type.exists()
|
| enc-2 | error | Encounter.participant | 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 | Encounter.meta.extension, Encounter.meta.extension:meta, Encounter.text.extension, Encounter.text.extension:text, Encounter.extension, Encounter.extension:statusHistory, Encounter.extension:classHistory, Encounter.modifierExtension, Encounter.identifier.extension, Encounter.identifier.extension:identifier, Encounter.status.extension, Encounter.status.extension:status, Encounter.subject.extension, Encounter.subject.extension:subject, Encounter.episodeOfCare.extension, Encounter.episodeOfCare.extension:episodeOfCare, Encounter.basedOn.extension, Encounter.basedOn.extension:incomingReferral, Encounter.partOf.extension, Encounter.partOf.extension:partOf, Encounter.serviceProvider.extension, Encounter.serviceProvider.extension:serviceProvider, Encounter.participant.extension, Encounter.participant.modifierExtension, Encounter.participant.period.extension, Encounter.participant.period.extension:period, Encounter.participant.actor.extension, Encounter.participant.actor.extension:individual, Encounter.appointment.extension, Encounter.appointment.extension:appointment, Encounter.actualPeriod.extension, Encounter.actualPeriod.extension:period, Encounter.reason.extension, Encounter.reason.modifierExtension, Encounter.diagnosis.extension, Encounter.diagnosis.extension:rank, Encounter.diagnosis.modifierExtension, Encounter.diagnosis.condition.extension, Encounter.diagnosis.condition.extension:condition, Encounter.account.extension, Encounter.account.extension:account, Encounter.admission.extension, Encounter.admission.extension:dietPreference, Encounter.admission.extension:specialCourtesy, Encounter.admission.extension:specialArrangement, Encounter.admission.modifierExtension, Encounter.admission.preAdmissionIdentifier.extension, Encounter.admission.preAdmissionIdentifier.extension:preAdmissionIdentifier, Encounter.admission.origin.extension, Encounter.admission.origin.extension:origin, Encounter.admission.destination.extension, Encounter.admission.destination.extension:destination, Encounter.location.extension, Encounter.location.modifierExtension, Encounter.location.location.extension, Encounter.location.location.extension:location, Encounter.location.period.extension, Encounter.location.period.extension:period | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| txt-1 | error | Encounter.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes |
htmlChecks()
|
| txt-2 | error | Encounter.text.div | The narrative SHALL have some non-whitespace content |
htmlChecks()
|
This structure is derived from Encounter
Summary
Mandatory: 0 element(2 nested mandatory elements)
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron