OpenMRS FHIR2 Implementation Guide
0.1.0 - ci-build
OpenMRS FHIR2 Implementation Guide - Local Development build (v0.1.0). See the Directory of published versions
Defining URL: | http://fhir.openmrs.org/fhir/StructureDefinition/omrs-encounter |
Version: | 0.1.0 |
Name: | OMRSEncounter |
Title: | Openmrs Encounter |
Status: | Active as of 2022-11-29 05:06:49+0000 |
Definition: | A FHIR Encounter as understood by OpenMRS |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://fhir.openmrs.org/fhir/StructureDefinition/omrs-encounter
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Encounter
Summary
Mandatory: 4 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() | 1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Tags applied to this resource Slice: Unordered, Closed by value:system | |
![]() ![]() ![]() | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | |
![]() ![]() ![]() | 1..* | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | Reference(OpenMRS Patient) | The patient or group present at the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() | 1..1 | Reference(OpenMRS Location) | Location the encounter takes place | |
![]() ![]() ![]() | 0..1 | Reference(Openmrs Encounter) | Another Encounter this encounter is part of | |
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 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: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Closed by value:system 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: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 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. | ||||
![]() ![]() ![]() | 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..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(OpenMRS Patient) | The patient or group present at the 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 | ||||
![]() ![]() ![]() | 1..1 | Period | The start and end time of the encounter | |||||
![]() ![]() ![]() | Σ | 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..* | 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(OpenMRS 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 | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() | 0..1 | Reference(Openmrs Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() |
This structure is derived from Encounter
Summary
Mandatory: 4 elements
Prohibited: 10 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Encounter
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |
![]() ![]() ![]() | 1..1 | id | Logical id of this artifact | |
![]() ![]() ![]() | ||||
![]() ![]() ![]() ![]() | 0..* | Coding | Tags applied to this resource Slice: Unordered, Closed by value:system | |
![]() ![]() ![]() | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + | |
![]() ![]() ![]() | 1..* | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | Reference(OpenMRS Patient) | The patient or group present at the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | List of participants involved in the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 1..1 | Period | The start and end time of the encounter | |
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..0 | |||
![]() ![]() ![]() | 0..* | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() | 1..1 | Reference(OpenMRS Location) | Location the encounter takes place | |
![]() ![]() ![]() | 0..1 | Reference(Openmrs Encounter) | Another Encounter this encounter is part of | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() | 0..* | Encounter | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() | Σ | 1..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() | Σ | 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: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System. | ||||
![]() ![]() ![]() ![]() | Σ | 0..* | Coding | Tags applied to this resource Slice: Unordered, Closed by value:system 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: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() | 0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() | ?! | 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. | ||||
![]() ![]() ![]() | 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..* | CodeableConcept | Specific type of encounter Binding: EncounterType (example): The type of encounter. | ||||
![]() ![]() ![]() | Σ | 1..1 | Reference(OpenMRS Patient) | The patient or group present at the 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 | ||||
![]() ![]() ![]() | 1..1 | Period | The start and end time of the encounter | |||||
![]() ![]() ![]() | Σ | 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..* | 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(OpenMRS 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 | |||||
![]() ![]() ![]() | 0..1 | Reference(Organization) | The organization (facility) responsible for this encounter | |||||
![]() ![]() ![]() | 0..1 | Reference(Openmrs Encounter) | Another Encounter this encounter is part of | |||||
![]() |
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet | ||||
Encounter.meta.security | extensible | All Security Labels | ||||
Encounter.meta.tag | example | CommonTags | ||||
Encounter.language | preferred | CommonLanguages
| ||||
Encounter.status | required | EncounterStatus | ||||
Encounter.statusHistory.status | required | EncounterStatus | ||||
Encounter.class | extensible | ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCode | ||||
Encounter.type | example | EncounterType | ||||
Encounter.participant.type | extensible | ParticipantType | ||||
Encounter.diagnosis.use | preferred | DiagnosisRole | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSource | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicator | ||||
Encounter.hospitalization.dietPreference | example | Diet | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesy | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangements | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDisposition | ||||
Encounter.location.status | required | EncounterLocationStatus | ||||
Encounter.location.physicalType | example | LocationType |
Id | Grade | Path(s) | Details | Requirements |
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() |