Common Data Models Harmonization, published by HL7 International - Biomedical Research and Regulation Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0). This version is based on the current content of https://github.com/HL7/cdmh/ and changes regularly. See the Directory of published versions
Defining URL: | http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-encounter |
Version: | 1.0.0 |
Name: | CdmhEncounter |
Title: | CDMH Encounter |
Status: | Draft as of 9/1/19 |
Definition: | This is the Encounter Resource profile for the IG. |
Publisher: | HL7 International - Biomedical Research and Regulation Work Group |
Copyright: | Used by permission of HL7, all rights reserved Creative Commons License |
Source Resource: | XML / JSON / Turtle |
The official URL for this profile is:
http://hl7.org/fhir/us/cdmh/StructureDefinition/cdmh-encounter
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Other representations of profile: CSV, Excel, Schematron
Path | Conformance | ValueSet |
Encounter.language | preferred | CommonLanguages Max Binding: AllLanguages |
Encounter.identifier.use | required | IdentifierUse |
Encounter.identifier.type | extensible | Identifier Type Codes |
Encounter.status | required | EncounterStatus |
Encounter.statusHistory.status | required | EncounterStatus |
Encounter.class | extensible | PCORNetEncounterType |
Encounter.classHistory.class | extensible | ActEncounterCode |
Encounter.type | extensible | USCoreEncounterType |
Encounter.serviceType | example | ServiceType |
Encounter.priority | example | ActPriority |
Encounter.participant.type | extensible | ParticipantType |
Encounter.reasonCode | preferred | EncounterReasonCodes |
Encounter.diagnosis.use | extensible | PCORNetDiagnosisClassification |
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 | extensible | PCORNetDischargeDisposition |
Encounter.location.status | required | EncounterLocationStatus |
Encounter.location.physicalType | example | LocationType |
Id | Path | Details | Requirements |
dom-2 | Encounter | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
dom-3 | 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 | 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 | Encounter | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
dom-6 | Encounter | A resource should have narrative for robust management : text.`div`.exists() | |
ele-1 | Encounter.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.extension:pcornet-drg-group | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension:pcornet-drg-group | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.extension:pcornet-drg-group-version | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.extension:pcornet-drg-group-version | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.identifier.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.identifier.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.system | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.value | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.identifier.assigner | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.statusHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.statusHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.statusHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.statusHistory.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.statusHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.classHistory.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.classHistory.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.classHistory.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.classHistory.class | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.classHistory.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.serviceType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.priority | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.subject | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.episodeOfCare | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.basedOn | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.participant.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.participant.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.participant.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.participant.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.participant.individual | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.appointment | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.period.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.period.start | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.period.end | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.length | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.reasonCode | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.reasonReference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.extension:pcornet-diagnosis-origin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.extension:pcornet-diagnosis-origin | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.diagnosis.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.diagnosis.condition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.use | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.diagnosis.rank | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.account | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.extension:pcornet-admitting-source-facility-type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension:pcornet-admitting-source-facility-type | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.extension:pcornet-discharge-status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.extension:pcornet-discharge-status | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.hospitalization.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.hospitalization.preAdmissionIdentifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.origin | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.admitSource | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.reAdmission | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.dietPreference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.specialCourtesy | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.specialArrangement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.destination | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.hospitalization.dischargeDisposition | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.location.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.location.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | Encounter.location.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ele-1 | Encounter.location.location | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.status | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.physicalType | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.location.period | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.serviceProvider | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ele-1 | Encounter.partOf | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |