FHIR Artifacts > Structure Definition: Encounter Profile

Profile: Encounter

Simplifier project page: Encounter

Derived from: Encounter (R4)

OLIS v2 to FHIR mapping: Encounter mapping

FHIR_VersionIG_StatusCanonical_URL
4.0.1activehttp://ehealthontario.ca/fhir/StructureDefinition/ca-on-lab-profile-Encounter

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work

Differential View

idS Σ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
status1..1codeBinding
periodI1..1Period
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
class1..1CodingBinding
periodI1..1Period
typeΣ0..*CodeableConcept
serviceTypeΣ0..1CodeableConcept
priority0..1CodeableConcept
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
episodeOfCareΣ I0..*Reference(EpisodeOfCare)
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
periodI0..1Period
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
appointmentΣ I0..*Reference(Appointment)
periodI0..1Period
lengthI0..1Duration
reasonCodeΣ0..*CodeableConceptBinding
reasonReferenceΣ I0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
conditionΣ I1..1Reference(Condition | Procedure)
use0..1CodeableConceptBinding
rank0..1positiveInt
accountI0..*Reference(Account)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
preAdmissionIdentifier0..1Identifier
originI0..1Reference(Location | Organization)
admitSource0..1CodeableConceptBinding
reAdmission0..1CodeableConcept
dietPreference0..*CodeableConcept
specialCourtesy0..*CodeableConceptBinding
specialArrangement0..*CodeableConceptBinding
destinationI0..1Reference(Location | Organization)
dischargeDisposition0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
status0..1codeBinding
physicalType0..1CodeableConcept
periodI0..1Period
serviceProviderI0..1Reference(Organization)
partOfI0..1Reference(Encounter)

Hybrid View

idS Σ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
status1..1codeBinding
periodI1..1Period
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
class1..1CodingBinding
periodI1..1Period
typeΣ0..*CodeableConcept
serviceTypeΣ0..1CodeableConcept
priority0..1CodeableConcept
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
episodeOfCareΣ I0..*Reference(EpisodeOfCare)
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
periodI0..1Period
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
appointmentΣ I0..*Reference(Appointment)
periodI0..1Period
lengthI0..1Duration
reasonCodeΣ0..*CodeableConceptBinding
reasonReferenceΣ I0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
conditionΣ I1..1Reference(Condition | Procedure)
use0..1CodeableConceptBinding
rank0..1positiveInt
accountI0..*Reference(Account)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
preAdmissionIdentifier0..1Identifier
originI0..1Reference(Location | Organization)
admitSource0..1CodeableConceptBinding
reAdmission0..1CodeableConcept
dietPreference0..*CodeableConcept
specialCourtesy0..*CodeableConceptBinding
specialArrangement0..*CodeableConceptBinding
destinationI0..1Reference(Location | Organization)
dischargeDisposition0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
status0..1codeBinding
physicalType0..1CodeableConcept
periodI0..1Period
serviceProviderI0..1Reference(Organization)
partOfI0..1Reference(Encounter)

Snapshot View

idS Σ0..1string
id0..1string
extensionI0..*Extension
versionIdΣ0..1id
lastUpdatedΣ0..1instant
sourceΣ0..1uri
profileS Σ1..1canonical(StructureDefinition)Fixed Value
securityΣ0..*CodingBinding
tagΣ0..*Coding
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
statusS Σ ?!1..1codeBindingFixed Value
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
status1..1codeBinding
periodI1..1Period
id0..1string
extensionI0..*Extension
systemS Σ1..1uri
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
class1..1CodingBinding
periodI1..1Period
typeΣ0..*CodeableConcept
serviceTypeΣ0..1CodeableConcept
priority0..1CodeableConcept
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
episodeOfCareΣ I0..*Reference(EpisodeOfCare)
basedOnI0..*Reference(ServiceRequest)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
id0..1string
extensionI0..*Extension
systemS Σ1..1uriFixed Value
versionΣ0..1string
codeS Σ1..1code
displayS Σ1..1string
userSelectedΣ0..1boolean
textΣ0..1string
periodI0..1Period
id0..1string
extensionI0..*Extension
referenceS Σ I1..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayΣ0..1string
appointmentΣ I0..*Reference(Appointment)
periodI0..1Period
lengthI0..1Duration
reasonCodeΣ0..*CodeableConceptBinding
reasonReferenceΣ I0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
conditionΣ I1..1Reference(Condition | Procedure)
use0..1CodeableConceptBinding
rank0..1positiveInt
accountI0..*Reference(Account)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
preAdmissionIdentifier0..1Identifier
originI0..1Reference(Location | Organization)
admitSource0..1CodeableConceptBinding
reAdmission0..1CodeableConcept
dietPreference0..*CodeableConcept
specialCourtesy0..*CodeableConceptBinding
specialArrangement0..*CodeableConceptBinding
destinationI0..1Reference(Location | Organization)
dischargeDisposition0..1CodeableConcept
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
id0..1string
extensionI0..*Extension
referenceΣ I0..1string
typeΣ0..1uriBinding
identifierΣ0..1Identifier
displayS Σ1..1string
status0..1codeBinding
physicalType0..1CodeableConcept
periodI0..1Period
serviceProviderI0..1Reference(Organization)
partOfI0..1Reference(Encounter)

Table View

Encounter0..*
Encounter.idstring0..1
Encounter.metaMeta1..1
Encounter.meta.idstring0..1
Encounter.meta.extensionExtension0..*
Encounter.meta.versionIdid0..1
Encounter.meta.lastUpdatedinstant0..1
Encounter.meta.sourceuri0..1
Encounter.meta.profilecanonical(StructureDefinition)1..1
Encounter.meta.securityCoding0..*
Encounter.meta.tagCoding0..*
Encounter.implicitRulesuri0..1
Encounter.languagecode0..1
Encounter.textNarrative0..1
Encounter.containedResource0..*
Encounter.extensionExtension0..*
Encounter.modifierExtensionExtension0..*
Encounter.identifierIdentifier0..*
Encounter.statuscode1..1
Encounter.statusHistoryBackboneElement0..*
Encounter.statusHistory.idstring0..1
Encounter.statusHistory.extensionExtension0..*
Encounter.statusHistory.modifierExtensionExtension0..*
Encounter.statusHistory.statuscode1..1
Encounter.statusHistory.periodPeriod1..1
Encounter.classCoding1..1
Encounter.class.idstring0..1
Encounter.class.extensionExtension0..*
Encounter.class.systemuri1..1
Encounter.class.versionstring0..1
Encounter.class.codecode1..1
Encounter.class.displaystring1..1
Encounter.class.userSelectedboolean0..1
Encounter.classHistoryBackboneElement0..*
Encounter.classHistory.idstring0..1
Encounter.classHistory.extensionExtension0..*
Encounter.classHistory.modifierExtensionExtension0..*
Encounter.classHistory.classCoding1..1
Encounter.classHistory.periodPeriod1..1
Encounter.typeCodeableConcept0..*
Encounter.serviceTypeCodeableConcept0..1
Encounter.priorityCodeableConcept0..1
Encounter.subjectReference(Patient)1..1
Encounter.subject.idstring0..1
Encounter.subject.extensionExtension0..*
Encounter.subject.referencestring1..1
Encounter.subject.typeuri0..1
Encounter.subject.identifierIdentifier0..1
Encounter.subject.displaystring0..1
Encounter.episodeOfCareReference(EpisodeOfCare)0..*
Encounter.basedOnReference(ServiceRequest)0..*
Encounter.participantBackboneElement0..*
Encounter.participant.idstring0..1
Encounter.participant.extensionExtension0..*
Encounter.participant.modifierExtensionExtension0..*
Encounter.participant.typeCodeableConcept1..*
Encounter.participant.type.idstring0..1
Encounter.participant.type.extensionExtension0..*
Encounter.participant.type.codingCoding1..1
Encounter.participant.type.coding.idstring0..1
Encounter.participant.type.coding.extensionExtension0..*
Encounter.participant.type.coding.systemuri1..1
Encounter.participant.type.coding.versionstring0..1
Encounter.participant.type.coding.codecode1..1
Encounter.participant.type.coding.displaystring1..1
Encounter.participant.type.coding.userSelectedboolean0..1
Encounter.participant.type.textstring0..1
Encounter.participant.periodPeriod0..1
Encounter.participant.individualReference(Practitioner)1..1
Encounter.participant.individual.idstring0..1
Encounter.participant.individual.extensionExtension0..*
Encounter.participant.individual.referencestring1..1
Encounter.participant.individual.typeuri0..1
Encounter.participant.individual.identifierIdentifier0..1
Encounter.participant.individual.displaystring0..1
Encounter.appointmentReference(Appointment)0..*
Encounter.periodPeriod0..1
Encounter.lengthDuration0..1
Encounter.reasonCodeCodeableConcept0..*
Encounter.reasonReferenceReference(Condition | Procedure | Observation | ImmunizationRecommendation)0..*
Encounter.diagnosisBackboneElement0..*
Encounter.diagnosis.idstring0..1
Encounter.diagnosis.extensionExtension0..*
Encounter.diagnosis.modifierExtensionExtension0..*
Encounter.diagnosis.conditionReference(Condition | Procedure)1..1
Encounter.diagnosis.useCodeableConcept0..1
Encounter.diagnosis.rankpositiveInt0..1
Encounter.accountReference(Account)0..*
Encounter.hospitalizationBackboneElement0..1
Encounter.hospitalization.idstring0..1
Encounter.hospitalization.extensionExtension0..*
Encounter.hospitalization.modifierExtensionExtension0..*
Encounter.hospitalization.preAdmissionIdentifierIdentifier0..1
Encounter.hospitalization.originReference(Location | Organization)0..1
Encounter.hospitalization.admitSourceCodeableConcept0..1
Encounter.hospitalization.reAdmissionCodeableConcept0..1
Encounter.hospitalization.dietPreferenceCodeableConcept0..*
Encounter.hospitalization.specialCourtesyCodeableConcept0..*
Encounter.hospitalization.specialArrangementCodeableConcept0..*
Encounter.hospitalization.destinationReference(Location | Organization)0..1
Encounter.hospitalization.dischargeDispositionCodeableConcept0..1
Encounter.locationBackboneElement0..1
Encounter.location.idstring0..1
Encounter.location.extensionExtension0..*
Encounter.location.modifierExtensionExtension0..*
Encounter.location.locationReference(Location)1..1
Encounter.location.location.idstring0..1
Encounter.location.location.extensionExtension0..*
Encounter.location.location.referencestring0..1
Encounter.location.location.typeuri0..1
Encounter.location.location.identifierIdentifier0..1
Encounter.location.location.displaystring1..1
Encounter.location.statuscode0..1
Encounter.location.physicalTypeCodeableConcept0..1
Encounter.location.periodPeriod0..1
Encounter.serviceProviderReference(Organization)0..1
Encounter.partOfReference(Encounter)0..1

JSON View

{
    "resourceType": "SearchParameter",
    "id": "CarePlan-encounter",
    "extension":  [
        {
            "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
            "valueCode": "trial-use"
        }
    ],
    "url": "http://hl7.org/fhir/SearchParameter/CarePlan-encounter",
    "version": "4.0.1",
    "name": "encounter",
    "status": "draft",
    "experimental": false,
    "date": "2019-11-01T09:29:23+11:00",
    "publisher": "Health Level Seven International (Patient Care)",
    "contact":  [
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://hl7.org/fhir"
                }
            ]
        },
        {
            "telecom":  [
                {
                    "system": "url",
                    "value": "http://www.hl7.org/Special/committees/patientcare/index.cfm"
                }
            ]
        }
    ],
    "description": "Encounter created as part of",
    "code": "encounter",
    "base":  [
        "CarePlan"
    ],
    "type": "reference",
    "expression": "CarePlan.encounter",
    "xpath": "f:CarePlan/f:encounter",
    "xpathUsage": "normal",
    "target":  [
        "Encounter"
    ]
}

Usage

The Encounter resource represents a patient visit related to the lab report from OLIS. This resource maps to the PV1 segment.

Notes

.id

  • This field SHALL contain an arbitrary id used for reference purposes.

.status

  • This field SHALL contain a code that indicates the status of the encounter associated with the lab report.

.class

  • Indicate the classification of the patient encounter associated with the request for laboratory information, (e.g., in the community (practitioner’s office), outpatient of a healthcare facility, inpatient of a healthcare facility, resident of a long-term care facility, in the emergency department).
  • maps to PV1.2 (Patient class)

.subject

  • SHALL contains a reference to the patient resource instance in the bundle

.participant

  • SHOULD contain the attending physician and admitting physician information
  • participant.type contains the code indicating the type of physician (attending, admitting)
  • participant.individual contains the reference to the practitioner resource in the bundle

.location.display

  • SHOULD contain a string to identify the nursing station or hospital service (e.g., ICU) for inpatient locations, or clinic or department for outpatient locations