1.5.3 - release
SHINNYHRSN - Local Development build (v1.5.3) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Official URL: http://shinny.org/us/ny/hrsn/StructureDefinition/shinny-encounter | Version: 1.5.3 | |||
Computable Name: SHINNYEncounterProfile |
The SHINNY Encounter resource is profiled off of the USCore Encounter, which sets minimum expectations for the Encounter resource to record, search, and fetch basic encounter information for an individual patient. It identifies which core elements, extensions, vocabularies and value sets SHALL be present in the resource when using this profile.
The Encounter profile is required for all screening, assessment and referral bundles.
The Location reference within the Encounter profile is required for all screenings.
Note that the meta.profile used for the location is the SDOH Clinical Care profile and when this profile is used the location.name is required for all locations.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | The diagnosis or procedure relevant to the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
0..1 | Reference(SHINNY Encounter Profile) | Another Encounter this encounter is part of ele-1: All FHIR elements must have a @value or children | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG | ||||
Encounter.type:405672008 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.type:23918007 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
S | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() ![]() |
S | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..1 | code | Language of the resource content |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 405672008 | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 23918007 | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter |
![]() ![]() ![]() |
1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter | |
![]() ![]() ![]() |
S | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | |
![]() ![]() ![]() |
S | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
0..1 | Reference(SHINNY Encounter Profile) | Another Encounter this encounter is part of | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 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) | ||||
![]() ![]() ![]() |
?!SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 Required Pattern: 405672008 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 Required Pattern: 23918007 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
SΣ | 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) | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | 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 | |||||
![]() ![]() ![]() |
S | 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 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||
![]() ![]() ![]() |
S | 0..1 | 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 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place | ||||
![]() ![]() ![]() ![]() |
S | 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(SHINNY Encounter Profile) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG | ||||
Encounter.type:405672008 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.type:23918007 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is known ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known . ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value ele-1: All FHIR elements must have a @value or children Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | string | The value that is unique ele-1: All FHIR elements must have a @value or children Example General: 123456 | ||||
![]() ![]() ![]() |
?!SΣ | 1..1 | code | planned | arrived | triaged | in-progress | onleave | finished | cancelled + Binding: EncounterStatus (required): Current state of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Coding | Classification of patient encounter Binding: ActEncounterCode (extensible): Classification of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | List of participants involved in the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Coded reason the encounter takes place Binding: EncounterReasonCodes (preferred): Reason why the encounter takes place. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | The diagnosis or procedure relevant to the encounter ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | Details about the admission to a healthcare service ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
S | 0..1 | BackboneElement | List of locations where the patient has been ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children ext-1: Must have either extensions or value[x], not both | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed Binding: EncounterLocationStatus (required): The status of the location. ele-1: All FHIR elements must have a @value or children | ||||
![]() ![]() ![]() |
0..1 | Reference(SHINNY Encounter Profile) | Another Encounter this encounter is part of ele-1: All FHIR elements must have a @value or children | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG | ||||
Encounter.type:405672008 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.type:23918007 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().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() |
Differential View
This structure is derived from USCoreEncounterProfile
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient | |
![]() ![]() ![]() |
S | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
![]() ![]() ![]() |
S | 1..1 | SHINNYMeta | Metadata about the resource |
![]() ![]() ![]() |
S | 0..1 | code | Language of the resource content |
![]() ![]() ![]() |
1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 405672008 | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Specific type of encounter | |
![]() ![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Required Pattern: 23918007 | |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Specific type of service |
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter |
![]() ![]() ![]() |
1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter | |
![]() ![]() ![]() |
S | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | |
![]() ![]() ![]() |
S | 0..* | Reference(Appointment) | The appointment that scheduled this encounter |
![]() ![]() ![]() |
S | 0..* | BackboneElement | The list of diagnosis relevant to this encounter |
![]() ![]() ![]() ![]() |
S | 0..1 | string | Unique id for inter-element referencing |
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | The diagnosis or procedure relevant to the encounter |
![]() ![]() ![]() |
0..1 | BackboneElement | List of locations where the patient has been | |
![]() ![]() ![]() ![]() |
S | 0..1 | code | planned | active | reserved | completed |
![]() ![]() ![]() |
0..1 | Reference(SHINNY Encounter Profile) | Another Encounter this encounter is part of | |
![]() |
Path | Conformance | ValueSet | URI |
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | USCoreEncounterProfile | An interaction during which services are provided to the patient | |||||
![]() ![]() ![]() |
SΣ | 1..1 | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | SHINNYMeta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..* | Identifier | Identifier(s) by which this encounter is 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. | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient | ||||
![]() ![]() ![]() ![]() |
SΣ | 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) | ||||
![]() ![]() ![]() |
?!SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 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 | |||||
![]() ![]() ![]() |
SΣ | 1..1 | CodeableConcept | Specific type of encounter Slice: Unordered, Open by value:coding.code Binding: SHINNYEncounterTypeVS (extensible) | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 Required Pattern: 405672008 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of encounter Binding: US Core Encounter Type (extensible): Valueset to describe the Encounter Type | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..* | 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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 Required Pattern: 23918007 | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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 | ||||
![]() ![]() ![]() |
SΣ | 0..1 | CodeableConcept | Specific type of service Binding: ServiceType (example): Broad categorization of the service that is to be provided. | ||||
![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Indicates the urgency of the encounter Binding: ActPriority (example): Indicates the urgency of the encounter. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY Patient Profile) | The patient or group present at the encounter | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(EpisodeOfCare) | Episode(s) of care that this encounter should be recorded against | ||||
![]() ![]() ![]() |
0..* | Reference(ServiceRequest) | The ServiceRequest that initiated this encounter | |||||
![]() ![]() ![]() |
SΣ | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | Role of participant in encounter Binding: ParticipantType (extensible): Role of participant in encounter. | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | Period | Period of time during the encounter that the participant participated | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(US Core Practitioner Profile) | Persons involved in the encounter other than the patient | ||||
![]() ![]() ![]() |
SΣ | 0..* | Reference(Appointment) | The appointment that scheduled this encounter | ||||
![]() ![]() ![]() |
S | 0..1 | Period | The start and end time of the encounter | ||||
![]() ![]() ![]() |
0..1 | Duration | Quantity of time the encounter lasted (less time absent) | |||||
![]() ![]() ![]() |
SΣ | 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) | ||||
![]() ![]() ![]() |
SΣ | 0..* | BackboneElement | The list of diagnosis relevant to this encounter | ||||
![]() ![]() ![]() ![]() |
S | 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 | ||||
![]() ![]() ![]() ![]() |
SΣ | 1..1 | Reference(SHINNY SDOHCC Condition Profile) | 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 | |||||
![]() ![]() ![]() |
S | 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 | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | CodeableConcept | Category or kind of location after discharge Binding: DischargeDisposition (example): Discharge Disposition. | ||||
![]() ![]() ![]() |
S | 0..1 | 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 | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Reference(Location) | Location the encounter takes place | ||||
![]() ![]() ![]() ![]() |
S | 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(SHINNY Encounter Profile) | Another Encounter this encounter is part of | |||||
![]() |
Path | Conformance | ValueSet | URI | |||
Encounter.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
Encounter.identifier.use | required | IdentifierUsehttp://hl7.org/fhir/ValueSet/identifier-use|4.0.1 from the FHIR Standard | ||||
Encounter.identifier.type | extensible | Identifier Type Codeshttp://hl7.org/fhir/ValueSet/identifier-type from the FHIR Standard | ||||
Encounter.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.statusHistory.status | required | EncounterStatushttp://hl7.org/fhir/ValueSet/encounter-status|4.0.1 from the FHIR Standard | ||||
Encounter.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.classHistory.class | extensible | ActEncounterCodehttp://terminology.hl7.org/ValueSet/v3-ActEncounterCode | ||||
Encounter.type | extensible | SHINNYEncounterTypeVShttp://shinny.org/us/ny/hrsn/ValueSet/SHINNYEncounterTypeVS from this IG | ||||
Encounter.type:405672008 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.type:23918007 | extensible | USCoreEncounterTypehttp://hl7.org/fhir/us/core/ValueSet/us-core-encounter-type | ||||
Encounter.serviceType | example | ServiceTypehttp://hl7.org/fhir/ValueSet/service-type from the FHIR Standard | ||||
Encounter.priority | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | ||||
Encounter.participant.type | extensible | ParticipantTypehttp://hl7.org/fhir/ValueSet/encounter-participant-type from the FHIR Standard | ||||
Encounter.reasonCode | preferred | EncounterReasonCodeshttp://hl7.org/fhir/ValueSet/encounter-reason from the FHIR Standard | ||||
Encounter.diagnosis.use | preferred | DiagnosisRolehttp://hl7.org/fhir/ValueSet/diagnosis-role from the FHIR Standard | ||||
Encounter.hospitalization.admitSource | preferred | AdmitSourcehttp://hl7.org/fhir/ValueSet/encounter-admit-source from the FHIR Standard | ||||
Encounter.hospitalization.reAdmission | example | Hl7VSReAdmissionIndicatorhttp://terminology.hl7.org/ValueSet/v2-0092 | ||||
Encounter.hospitalization.dietPreference | example | Diethttp://hl7.org/fhir/ValueSet/encounter-diet from the FHIR Standard | ||||
Encounter.hospitalization.specialCourtesy | preferred | SpecialCourtesyhttp://hl7.org/fhir/ValueSet/encounter-special-courtesy from the FHIR Standard | ||||
Encounter.hospitalization.specialArrangement | preferred | SpecialArrangementshttp://hl7.org/fhir/ValueSet/encounter-special-arrangements from the FHIR Standard | ||||
Encounter.hospitalization.dischargeDisposition | example | DischargeDispositionhttp://hl7.org/fhir/ValueSet/encounter-discharge-disposition from the FHIR Standard | ||||
Encounter.location.status | required | EncounterLocationStatushttp://hl7.org/fhir/ValueSet/encounter-location-status|4.0.1 from the FHIR Standard | ||||
Encounter.location.physicalType | example | LocationTypehttp://hl7.org/fhir/ValueSet/location-physical-type from the FHIR Standard |
Id | Grade | Path(s) | Details | Requirements |
dom-2 | error | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | error | Encounter | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty() | |
dom-4 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
dom-5 | error | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | best practice | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from USCoreEncounterProfile
Summary
Mandatory: 2 elements(3 nested mandatory elements)
Must-Support: 11 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Other representations of profile: CSV, Excel, Schematron