1.0.0 - release
            
          
CambioOpenServicesIG - Local Development build (v1.0.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: https://fhir.cambio.se/StructureDefinition/EncounterOutpatientCoreSe | Version: 1.0.0 | |||
| Active as of 2025-10-27 | Computable Name: EncounterOutpatientCoreSe | |||
This is an Encounter profile to be used for outpatient encounters, in a Swedish context.
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:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | 
![]() ![]()  | 
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. Required Pattern: At least the following  | 
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system | |
![]() ![]() ![]()  | 
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |
![]() ![]() ![]()  | 
0..1 | string | Representation defined by the system | |
![]() ![]() ![]()  | 
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | 
![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | The patient or group present at the encounter | 
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | 
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | |
| Encounter.class | extensible | Pattern Value: AMBhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | |
| Encounter.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | |
| Encounter.serviceProvider.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()  | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()  | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |
![]() ![]()  | 
1..1 | Coding | Classification of patient encounter Required Pattern: At least the following  | |
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |
![]() ![]()  | 
1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | |
![]() ![]() ![]()  | 
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]()  | 
1..1 | Reference(Patient | Group) | The patient or group present at the encounter | |
![]() ![]() ![]()  | 
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]()  | 
1..1 | string | The value that is unique | |
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]()  | 
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | |
![]() ![]() ![]() ![]()  | 
1..1 | string | The value that is unique | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | ||||
![]() ![]()  | 
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | |||||
![]() ![]() ![]()  | 
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]()  | 
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. Required Pattern: At least the following  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]()  | 
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |||||
![]() ![]() ![]()  | 
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]()  | 
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]()  | 
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.  | |||||
![]() ![]() ![]()  | 
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]()  | 
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.  | ||||
![]() ![]()  | 
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.  | |||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..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 | string | Text alternative for the resource | ||||
![]() ![]()  | 
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 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 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]()  | 
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]()  | 
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]()  | 
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]()  | 
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.  | ||||
![]() ![]()  | 
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.  | |||||
![]() ![]() ![]()  | 
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]()  | 
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]()  | 
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]()  | 
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.  | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.  | |||||
![]() ![]() ![]()  | 
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]()  | 
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 | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]()  | 
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.  | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.  | |||||
![]() ![]() ![]()  | 
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..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 | string | Text alternative for the resource | ||||
![]() ![]()  | 
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | ||||
| Encounter.class | extensible | Pattern Value: AMBhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard  | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Encounter.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Encounter.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard  | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard  | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourceFrom the FHIR Standard  | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietFrom the FHIR Standard  | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyFrom the FHIR Standard  | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsFrom the FHIR Standard  | ||||
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionFrom the FHIR Standard  | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard  | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard  | ||||
| Encounter.serviceProvider.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Encounter.serviceProvider.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Encounter.serviceProvider.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()  | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()  | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
This structure is derived from Encounter
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | 
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | 
![]() ![]()  | 
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | 
![]() ![]()  | 
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. Required Pattern: At least the following  | 
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system | |
![]() ![]() ![]()  | 
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |
![]() ![]() ![]()  | 
0..1 | string | Representation defined by the system | |
![]() ![]() ![]()  | 
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | 
![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system | 
![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | The patient or group present at the encounter | 
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | 
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | 
![]() ![]() ![]() ![]()  | 
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | 
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | string | The value that is unique Example General: 123456  | 
  Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI | 
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | |
| Encounter.class | extensible | Pattern Value: AMBhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | |
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | |
| Encounter.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | |
| Encounter.serviceProvider.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()  | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()  | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
Differential View
This structure is derived from Encounter
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | 
|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | 
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |
![]() ![]()  | 
1..1 | Coding | Classification of patient encounter Required Pattern: At least the following  | |
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |
![]() ![]()  | 
1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | |
![]() ![]() ![]()  | 
1..* | Coding | Code defined by a terminology system | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | Identity of the terminology system | |
![]() ![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system | |
![]() ![]()  | 
1..1 | Reference(Patient | Group) | The patient or group present at the encounter | |
![]() ![]() ![]()  | 
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | The namespace for the identifier value | |
![]() ![]() ![]() ![]()  | 
1..1 | string | The value that is unique | |
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |
![]() ![]() ![]()  | 
1..1 | Identifier | Logical reference, when literal reference is not known | |
![]() ![]() ![]() ![]()  | 
1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | |
![]() ![]() ![]() ![]()  | 
1..1 | string | The value that is unique | |
  Documentation for this format | ||||
| Path | Conformance | ValueSet | URI | 
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints    Filter:  ![]() ![]()  | ||||
|---|---|---|---|---|---|---|---|---|
![]()  | 
C | 0..* | Encounter | An interaction during which services are provided to the patient Constraints: finished-encounter-invariant, in-progress-encounter-invariant, planned-encounter-invariant, arrived-encounter-invariant  | ||||
![]() ![]()  | 
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]()  | 
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]()  | 
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]()  | 
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language. 
  | |||||
![]() ![]()  | 
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements  | |||||
![]() ![]()  | 
0..* | Resource | Contained, inline Resources | |||||
![]() ![]()  | 
1..* | Extension | Extension Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
1..1 | Reference(Organization) | EncounterPerformingUnit URL: https://fhir.cambio.se/StructureDefinition/encounterPerformingUnit  | |||||
![]() ![]()  | 
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]()  | 
Σ | 0..* | Identifier | Identifier(s) by which this encounter is known | ||||
![]() ![]()  | 
?!Σ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | ||||
![]() ![]()  | 
0..* | BackboneElement | List of past encounter statuses | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter.  | |||||
![]() ![]() ![]()  | 
1..1 | Period | The time that the episode was in the specified status | |||||
![]() ![]()  | 
Σ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. Required Pattern: At least the following  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
0..1 | uri | Identity of the terminology system | |||||
![]() ![]() ![]()  | 
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]()  | 
1..1 | code | Symbol in syntax defined by the system Fixed Value: AMB  | |||||
![]() ![]() ![]()  | 
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]()  | 
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]()  | 
0..* | BackboneElement | List of past encounter classes | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Coding | inpatient | outpatient | ambulatory | emergency + Binding: ActEncounterCode (extensible): Classification of the encounter.  | |||||
![]() ![]() ![]()  | 
1..1 | Period | The time that the episode was in the specified class | |||||
![]() ![]()  | 
Σ | 1..1 | CodeableConcept | Specific type of encounter Binding: Encounter Types Value Set (extensible)  | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
Σ | 1..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]()  | 
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]()  | 
Σ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided.  | ||||
![]() ![]()  | 
0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter.  | |||||
![]() ![]()  | 
Σ | 1..1 | Reference(Patient | Group) | The patient or group present at the encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..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 | string | Text alternative for the resource | ||||
![]() ![]()  | 
Σ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]()  | 
0..1 | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | List of participants involved in the encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 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 | Reference(Practitioner | PractitionerRole | RelatedPerson) | Persons involved in the encounter other than the patient | ||||
![]() ![]()  | 
Σ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]()  | 
0..1 | Period | The start and end time of the encounter | |||||
![]() ![]()  | 
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]()  | 
Σ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place.  | ||||
![]() ![]()  | 
Σ | 0..* | Reference(Condition | Procedure | Observation | ImmunizationRecommendation) | Reason the encounter takes place (reference) | ||||
![]() ![]()  | 
Σ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Reference(Condition | Procedure) | The diagnosis or procedure relevant to the encounter | ||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | Role that this diagnosis has within the encounter (e.g. admission, billing, discharge …) Binding: DiagnosisRole (preferred): The type of diagnosis this condition represents.  | |||||
![]() ![]() ![]()  | 
0..1 | positiveInt | Ranking of the diagnosis (for each role type) | |||||
![]() ![]()  | 
0..* | Reference(Account) | The set of accounts that may be used for billing for this Encounter | |||||
![]() ![]()  | 
0..1 | BackboneElement | Details about the admission to a healthcare service | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
0..1 | Identifier | Pre-admission identifier | |||||
![]() ![]() ![]()  | 
0..1 | Reference(Location | Organization) | The location/organization from which the patient came before admission | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | From where patient was admitted (physician referral, transfer) Binding: AdmitSource (preferred): From where the patient was admitted.  | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | The type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission Binding: hl7VS-re-admissionIndicator (example): The reason for re-admission of this hospitalization encounter.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Diet preferences reported by the patient Binding: Diet (example): Medical, cultural or ethical food preferences to help with catering requirements.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Special courtesies (VIP, board member) Binding: SpecialCourtesy (preferred): Special courtesies.  | |||||
![]() ![]() ![]()  | 
0..* | CodeableConcept | Wheelchair, translator, stretcher, etc. Binding: SpecialArrangements (preferred): Special arrangements.  | |||||
![]() ![]() ![]()  | 
0..1 | Reference(Location | Organization) | Location/organization to which the patient is discharged | |||||
![]() ![]() ![]()  | 
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 | |||||
![]() ![]() ![]()  | 
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]()  | 
1..1 | Reference(Location) | Location the encounter takes place | |||||
![]() ![]() ![]()  | 
0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location.  | |||||
![]() ![]() ![]()  | 
0..1 | CodeableConcept | The physical type of the location (usually the level in the location hierachy - bed room ward etc.) Binding: LocationType (example): Physical form of the location.  | |||||
![]() ![]() ![]()  | 
0..1 | Period | Time period during which the patient was present at the location | |||||
![]() ![]()  | 
1..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]()  | 
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]()  | 
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).  | ||||
![]() ![]() ![]()  | 
Σ | 1..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]()  | 
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]()  | 
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url  | |||||
![]() ![]() ![]() ![]()  | 
?!Σ | 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: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..1 | uri | The namespace for the identifier value Required Pattern: urn:oid:1.2.752.29.4.19  | ||||
![]() ![]() ![]() ![]()  | 
Σ | 1..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 | string | Text alternative for the resource | ||||
![]() ![]()  | 
0..1 | Reference(Encounter) | Another Encounter this encounter is part of | |||||
  Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languagesFrom the FHIR Standard 
  | ||||
| Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | ||||
| Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1From the FHIR Standard  | ||||
| Encounter.class | extensible | Pattern Value: AMBhttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
| Encounter.type | extensible | EncounterTypesValueSethttps://cambio.codes/vs/encounter-types-value-setFrom this IG  | ||||
| Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-typeFrom the FHIR Standard  | ||||
| Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
| Encounter.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Encounter.subject.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Encounter.subject.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | ||||
| Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-typeFrom the FHIR Standard  | ||||
| Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reasonFrom the FHIR Standard  | ||||
| Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-roleFrom the FHIR Standard  | ||||
| Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-sourceFrom the FHIR Standard  | ||||
| Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
| Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-dietFrom the FHIR Standard  | ||||
| Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesyFrom the FHIR Standard  | ||||
| Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangementsFrom the FHIR Standard  | ||||
| Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-dispositionFrom the FHIR Standard  | ||||
| Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1From the FHIR Standard  | ||||
| Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-typeFrom the FHIR Standard  | ||||
| Encounter.serviceProvider.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesFrom the FHIR Standard  | ||||
| Encounter.serviceProvider.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1From the FHIR Standard  | ||||
| Encounter.serviceProvider.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-typeFrom the FHIR Standard  | 
| Id | Grade | Path(s) | Details | Requirements | 
| arrived-encounter-invariant | error | Encounter | If status is 'arrived', then period.start must be present and period.end must not be present. : status = 'arrived' implies (period.start.exists() and period.end.exists().not())  | |
| dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()  | |
| dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()  | |
| dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()  | |
| dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()  | |
| dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists()  | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())  | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists()  | |
| finished-encounter-invariant | error | Encounter | If status is 'finshed', then period.start and period.end must be present. : status = 'finished' implies (period.start.exists() and period.end.exists())  | |
| in-progress-encounter-invariant | error | Encounter | If status is 'in-progress', then period.start must be present and period.end must not be present. : status = 'in-progress' implies (period.start.exists() and period.end.exists().not())  | |
| planned-encounter-invariant | error | Encounter | If status is planned, then no period shall be present. : status = 'planned' implies (period.start.exists().not() and period.end.exists().not())  | 
This structure is derived from Encounter
Other representations of profile: CSV, Excel, Schematron