HL7 FHIR Implementation Guide: minimal Common Oncology Data Elements (mCODE), v0.9.0

Publish Box goes here

Encounter

 

The official URL for this profile is:

http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Encounter

A description of an interaction between a patient and healthcare provider(s) for the purpose of providing healthcare service(s) or assessing the health status of a patient.

This profile builds on Encounter.

This profile was published on Wed Apr 17 00:00:00 EDT 2019 as a draft by The MITRE Corporation.

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Encounter maps to Encounter:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  Status maps to status
  StatusHistory maps to statusHistory
  StatusHistory.Status maps to statusHistory.status
  StatusHistory.TimePeriod maps to statusHistory.period
  EncounterClass maps to class
  ClassHistory.EncounterClass maps to extension
  ClassHistory.TimePeriod maps to extension
  Type maps to type
  PriorityCode maps to priority
  PatientSubjectOfRecord maps to patient
  EpisodeOfCare maps to episodeOfCare
  ReferralRequest maps to incomingReferral
  Participation maps to participant
  Participation.ParticipationType maps to participant.type
  Participation.ParticipationPeriod maps to participant.period
  Participation.Participant maps to participant.individual
  Appointment maps to appointment
  TimePeriod maps to period
  Duration maps to length
  ReasonCode maps to reason
  EncounterDiagnosis.DiagnosisCode maps to extension
  EncounterDiagnosis.Condition maps to extension
  EncounterDiagnosis.Type maps to extension
  EncounterDiagnosis.PriorityRank maps to extension
  EncounterLocation maps to location
  EncounterLocation.Location maps to location.location
  EncounterLocation.Status maps to location.status
  EncounterLocation.TimePeriod maps to location.period
  Organization maps to serviceProvider
  PartOf maps to partOf

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter shr-core-Encounter
... extension Slice: Unordered, Open by value:url
... shr-core-EncounterClass-extension 0..*CodeableConceptEncounterClass
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-EncounterClass-extension
... shr-core-TimePeriod-extension 0..*PeriodTimePeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TimePeriod-extension
... shr-core-DiagnosisCode-extension 0..*CodeableConceptDiagnosisCode
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-DiagnosisCode-extension
... shr-core-Condition-extension 0..*Reference(shr-core-Condition)Condition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Condition-extension
... shr-core-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... valueCodeableConcept Binding: diagnosis-role (preferred)
... shr-core-PriorityRank-extension 0..*positiveIntPriorityRank
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PriorityRank-extension
... type Binding: ActEncounterCode (extensible)
... priority Binding: ActPriority (example)
... patient 1..1Reference(shr-core-Patient)
... episodeOfCare Reference(shr-core-EpisodeOfCare)
... incomingReferral Reference(shr-core-ReferralRequest)
... participant
.... individual Reference(shr-core-Practitioner | shr-core-RelatedPerson)
... appointment Reference(shr-core-Appointment)
... length Duration
... reason Binding: Encounter Reason Codes (preferred)
... location
.... location Reference(shr-core-Location)
... serviceProvider Reference(shr-core-Organization)
... partOf Reference(shr-core-Encounter)

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*shr-core-Encounter
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-EncounterClass-extension 0..*CodeableConceptEncounterClass
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-EncounterClass-extension
... shr-core-TimePeriod-extension 0..*PeriodTimePeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TimePeriod-extension
... shr-core-DiagnosisCode-extension 0..*CodeableConceptDiagnosisCode
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-DiagnosisCode-extension
... shr-core-Condition-extension 0..*Reference(shr-core-Condition)Condition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Condition-extension
... shr-core-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: diagnosis-role (preferred)
... shr-core-PriorityRank-extension 0..*positiveIntPriorityRank
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PriorityRank-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | in-progress | onleave | finished | cancelled
Binding: EncounterState (required)
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | in-progress | onleave | finished | cancelled
Binding: EncounterState (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class Σ0..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required)
... type Σ0..*CodeableConceptSpecific type of encounter
Binding: ActEncounterCode (extensible)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example)
... patient Σ1..1Reference(shr-core-Patient)The patient present at the encounter
... episodeOfCare Σ0..*Reference(shr-core-EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(shr-core-ReferralRequest)The ReferralRequest that initiated this encounter
... participant Σ0..*BackboneElementList of participants involved in the encounter
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual Σ0..1Reference(shr-core-Practitioner | shr-core-RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ0..1Reference(shr-core-Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reason Σ0..*CodeableConceptReason the encounter takes place (code)
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the encounter takes place (resource)
... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location)The location from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... admittingDiagnosis 0..*Reference(Condition)The admitting diagnosis as reported by admitting practitioner
.... reAdmission 0..1CodeableConceptThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: (unbound) (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination 0..1Reference(Location)Location to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (preferred)
.... dischargeDiagnosis 0..*Reference(Condition)The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(shr-core-Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider 0..1Reference(shr-core-Organization)The custodian organization of this Encounter record
... partOf 0..1Reference(shr-core-Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Mapping Source

This structure represents the following mapping definition:

shr.core.Encounter maps to Encounter:
  _Entry.EntryId maps to id
  Language maps to language
  Narrative maps to text
  ImplicitRules maps to implicitRules
  Metadata.VersionId maps to meta.versionId
  Metadata.Profile maps to meta.profile
  Metadata.LastUpdated maps to meta.lastUpdated
  Metadata.SecurityLabel maps to meta.security
  Metadata.Tag maps to meta.tag
  Identifier maps to identifier
  Status maps to status
  StatusHistory maps to statusHistory
  StatusHistory.Status maps to statusHistory.status
  StatusHistory.TimePeriod maps to statusHistory.period
  EncounterClass maps to class
  ClassHistory.EncounterClass maps to extension
  ClassHistory.TimePeriod maps to extension
  Type maps to type
  PriorityCode maps to priority
  PatientSubjectOfRecord maps to patient
  EpisodeOfCare maps to episodeOfCare
  ReferralRequest maps to incomingReferral
  Participation maps to participant
  Participation.ParticipationType maps to participant.type
  Participation.ParticipationPeriod maps to participant.period
  Participation.Participant maps to participant.individual
  Appointment maps to appointment
  TimePeriod maps to period
  Duration maps to length
  ReasonCode maps to reason
  EncounterDiagnosis.DiagnosisCode maps to extension
  EncounterDiagnosis.Condition maps to extension
  EncounterDiagnosis.Type maps to extension
  EncounterDiagnosis.PriorityRank maps to extension
  EncounterLocation maps to location
  EncounterLocation.Location maps to location.location
  EncounterLocation.Status maps to location.status
  EncounterLocation.TimePeriod maps to location.period
  Organization maps to serviceProvider
  PartOf maps to partOf

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter shr-core-Encounter
... extension Slice: Unordered, Open by value:url
... shr-core-EncounterClass-extension 0..*CodeableConceptEncounterClass
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-EncounterClass-extension
... shr-core-TimePeriod-extension 0..*PeriodTimePeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TimePeriod-extension
... shr-core-DiagnosisCode-extension 0..*CodeableConceptDiagnosisCode
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-DiagnosisCode-extension
... shr-core-Condition-extension 0..*Reference(shr-core-Condition)Condition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Condition-extension
... shr-core-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... valueCodeableConcept Binding: diagnosis-role (preferred)
... shr-core-PriorityRank-extension 0..*positiveIntPriorityRank
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PriorityRank-extension
... type Binding: ActEncounterCode (extensible)
... priority Binding: ActPriority (example)
... patient 1..1Reference(shr-core-Patient)
... episodeOfCare Reference(shr-core-EpisodeOfCare)
... incomingReferral Reference(shr-core-ReferralRequest)
... participant
.... individual Reference(shr-core-Practitioner | shr-core-RelatedPerson)
... appointment Reference(shr-core-Appointment)
... length Duration
... reason Binding: Encounter Reason Codes (preferred)
... location
.... location Reference(shr-core-Location)
... serviceProvider Reference(shr-core-Organization)
... partOf Reference(shr-core-Encounter)

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 0..*shr-core-Encounter
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: http://tools.ietf.org/html/bcp47 (required)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... shr-core-EncounterClass-extension 0..*CodeableConceptEncounterClass
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-EncounterClass-extension
... shr-core-TimePeriod-extension 0..*PeriodTimePeriod
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-TimePeriod-extension
... shr-core-DiagnosisCode-extension 0..*CodeableConceptDiagnosisCode
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-DiagnosisCode-extension
... shr-core-Condition-extension 0..*Reference(shr-core-Condition)Condition
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Condition-extension
... shr-core-Type-extension 0..*CodeableConceptType
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-Type-extension"
.... valueCodeableConcept 1..1CodeableConceptValue of extension
Binding: diagnosis-role (preferred)
... shr-core-PriorityRank-extension 0..*positiveIntPriorityRank
URL: http://hl7.org/fhir/us/shr/StructureDefinition/shr-core-PriorityRank-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | in-progress | onleave | finished | cancelled
Binding: EncounterState (required)
... statusHistory 0..*BackboneElementList of past encounter statuses
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | in-progress | onleave | finished | cancelled
Binding: EncounterState (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class Σ0..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required)
... type Σ0..*CodeableConceptSpecific type of encounter
Binding: ActEncounterCode (extensible)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: ActPriority (example)
... patient Σ1..1Reference(shr-core-Patient)The patient present at the encounter
... episodeOfCare Σ0..*Reference(shr-core-EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(shr-core-ReferralRequest)The ReferralRequest that initiated this encounter
... participant Σ0..*BackboneElementList of participants involved in the encounter
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual Σ0..1Reference(shr-core-Practitioner | shr-core-RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ0..1Reference(shr-core-Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted (less time absent)
... reason Σ0..*CodeableConceptReason the encounter takes place (code)
Binding: Encounter Reason Codes (preferred)
... indication 0..*Reference(Condition | Procedure)Reason the encounter takes place (resource)
... hospitalization 0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... preAdmissionIdentifier 0..1IdentifierPre-admission identifier
.... origin 0..1Reference(Location)The location from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... admittingDiagnosis 0..*Reference(Condition)The admitting diagnosis as reported by admitting practitioner
.... reAdmission 0..1CodeableConceptThe type of hospital re-admission that has occurred (if any). If the value is absent, then this is not identified as a readmission
Binding: (unbound) (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination 0..1Reference(Location)Location to which the patient is discharged
.... dischargeDisposition 0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (preferred)
.... dischargeDiagnosis 0..*Reference(Condition)The final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
... location 0..*BackboneElementList of locations where the patient has been
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(shr-core-Location)Location the encounter takes place
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider 0..1Reference(shr-core-Organization)The custodian organization of this Encounter record
... partOf 0..1Reference(shr-core-Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, TTL), Schema: XML Schematron

 

 

Constraints

IdPathDetailsRequirements