2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Profile: DAFEncounter

The official URL for this profile is: 

http://hl7.org/fhir/Profile/encounter-daf-dafencounter

. Defines constraints and extensions on the Encounter resource for use in querying and retrieving a patient's encounter related information. : U.S. Data Access Framework (DAF) Encounter profile

This profile was published on Thu, Aug 21, 2014 00:00+1000 as a draft by U.S. Office of the National Coordinator (ONC).

Summary

Terminology Bindings

  • Encounter.status must come from Current state of the encounter
  • Encounter.class must come from Classification of the encounter
  • Encounter.type should come from This value set defines a set of codes that can be used to indicate the type of encounter.
  • Encounter.reason must come from Value set to describe the specific encounter code

Required/Prohibited Elements

  • The element Encounter is required
  • The element Encounter.identifier is required
  • The element Encounter.status is required
  • The element Encounter.class is required
  • The element Encounter.patient is required

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

Differential View

This structure is derived from Encounter.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... identifier S1..*Identifier
... status S1..1codeplanned | in-progress | onleave | finished | cancelled
Binding: EncounterState (required, not extensible)
... class S1..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required, not extensible)
... type S0..1CodeableConceptSNOMED CT | ICD10-CM | CPT-4
Binding: dafEncounterType (preferred, extensible)
... patient S1..1patient-daf-dafpatientPatient present at encounter
... participant S0..*Element
.... type S0..*CodeableConcept
.... individual S0..1Practitioner, RelatedPerson
... period S0..1Period
... reason S0..1CodeableConceptBinding: DAFEncounterReasonValueset (required, extensible)
... hospitalization S0..1Element
.... dischargeDisposition S0..1CodeableConcept
.... dischargeDiagnosis S0..1Any
... location S0..1Element
.... location S0..1Location

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1An interaction during which services are provided to the patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..*IdentifierIdentifier(s) by which this encounter is known
... status M SΣ1..1codeplanned | in-progress | onleave | finished | cancelled
Binding: EncounterState (required, not extensible)
... statusHistory 0..*List of 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, not extensible)
.... period 1..1PeriodThe time that the episode was in the specified status
... class M SΣ1..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required, not extensible)
... type S Σ0..1CodeableConceptSNOMED CT | ICD10-CM | CPT-4
Binding: dafEncounterType (preferred, extensible)
... patient S Σ1..1patient-daf-dafpatientPatient present at encounter
... episodeOfCare Σ0..1EpisodeOfCareAn episode of care that this encounter should be recorded against
... participant S Σ0..*ElementList 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 S Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (preferred, extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual S Σ0..1Practitioner, RelatedPersonPersons involved in the encounter other than the patient
... fulfills Σ0..1AppointmentThe appointment that scheduled this encounter
... period S0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted
... reason S Σ0..1CodeableConceptReason the encounter takes place (code)
Binding: DAFEncounterReasonValueset (required, extensible)
... indication 0..*AnyReason the encounter takes place (resource)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: Priority (example, extensible)
... hospitalization S0..1ElementDetails about an admission to a clinic
.... 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..1LocationThe location from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred, extensible)
.... diet 0..1CodeableConceptDietary restrictions for the patient
Binding: PatientDiet (preferred, extensible)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: Courtesies (preferred, extensible)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc
Binding: Arrangements (preferred, extensible)
.... destination 0..1LocationLocation to which the patient is discharged
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisp (preferred, extensible)
.... dischargeDiagnosis S0..1AnyThe final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
.... reAdmission 0..1booleanIs this hospitalization a readmission?
... location S0..1ElementList of locations the patient has been at
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... location S0..1LocationLocation the encounter takes place
.... status 0..1codeplanned | present | reserved
Binding: EncounterLocationStatus (required, not extensible)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider 0..1OrganizationDepartment or team providing care
... partOf 0..1EncounterAnother Encounter this encounter is part of

XML Template

JSON Template

todo

Differential View

This structure is derived from Encounter.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1
... identifier S1..*Identifier
... status S1..1codeplanned | in-progress | onleave | finished | cancelled
Binding: EncounterState (required, not extensible)
... class S1..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required, not extensible)
... type S0..1CodeableConceptSNOMED CT | ICD10-CM | CPT-4
Binding: dafEncounterType (preferred, extensible)
... patient S1..1patient-daf-dafpatientPatient present at encounter
... participant S0..*Element
.... type S0..*CodeableConcept
.... individual S0..1Practitioner, RelatedPerson
... period S0..1Period
... reason S0..1CodeableConceptBinding: DAFEncounterReasonValueset (required, extensible)
... hospitalization S0..1Element
.... dischargeDisposition S0..1CodeableConcept
.... dischargeDiagnosis S0..1Any
... location S0..1Element
.... location S0..1Location

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter 1..1An interaction during which services are provided to the patient
... id 0..1idLogical id of this artefact
... meta 0..1MetaMetadata about the resource
... implicitRules M0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Language (required, not extensible)
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension 0..*ExtensionExtensions that cannot be ignored
... identifier S Σ1..*IdentifierIdentifier(s) by which this encounter is known
... status M SΣ1..1codeplanned | in-progress | onleave | finished | cancelled
Binding: EncounterState (required, not extensible)
... statusHistory 0..*List of 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, not extensible)
.... period 1..1PeriodThe time that the episode was in the specified status
... class M SΣ1..1codeinpatient | outpatient | ambulatory | emergency +
Binding: EncounterClass (required, not extensible)
... type S Σ0..1CodeableConceptSNOMED CT | ICD10-CM | CPT-4
Binding: dafEncounterType (preferred, extensible)
... patient S Σ1..1patient-daf-dafpatientPatient present at encounter
... episodeOfCare Σ0..1EpisodeOfCareAn episode of care that this encounter should be recorded against
... participant S Σ0..*ElementList 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 S Σ0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (preferred, extensible)
.... period 0..1PeriodPeriod of time during the encounter participant was present
.... individual S Σ0..1Practitioner, RelatedPersonPersons involved in the encounter other than the patient
... fulfills Σ0..1AppointmentThe appointment that scheduled this encounter
... period S0..1PeriodThe start and end time of the encounter
... length 0..1DurationQuantity of time the encounter lasted
... reason S Σ0..1CodeableConceptReason the encounter takes place (code)
Binding: DAFEncounterReasonValueset (required, extensible)
... indication 0..*AnyReason the encounter takes place (resource)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: Priority (example, extensible)
... hospitalization S0..1ElementDetails about an admission to a clinic
.... 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..1LocationThe location from which the patient came before admission
.... admitSource 0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred, extensible)
.... diet 0..1CodeableConceptDietary restrictions for the patient
Binding: PatientDiet (preferred, extensible)
.... specialCourtesy 0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: Courtesies (preferred, extensible)
.... specialArrangement 0..*CodeableConceptWheelchair, translator, stretcher, etc
Binding: Arrangements (preferred, extensible)
.... destination 0..1LocationLocation to which the patient is discharged
.... dischargeDisposition S0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisp (preferred, extensible)
.... dischargeDiagnosis S0..1AnyThe final diagnosis given a patient before release from the hospital after all testing, surgery, and workup are complete
.... reAdmission 0..1booleanIs this hospitalization a readmission?
... location S0..1ElementList of locations the patient has been at
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension 0..*ExtensionExtensions that cannot be ignored
.... location S0..1LocationLocation the encounter takes place
.... status 0..1codeplanned | present | reserved
Binding: EncounterLocationStatus (required, not extensible)
.... period 0..1PeriodTime period during which the patient was present at the location
... serviceProvider 0..1OrganizationDepartment or team providing care
... partOf 0..1EncounterAnother Encounter this encounter is part of

XML Template

JSON Template

todo

 

Other definitions: (todo)

Terminology Bindings

PathNameConformanceValueSet
Encounter.languageLanguagerequiredhttp://tools.ietf.org/html/bcp47
Encounter.statusEncounterStaterequiredEncounterState
Encounter.statusHistory.statusEncounterStaterequiredEncounterState
Encounter.classEncounterClassrequiredEncounterClass
Encounter.typedafEncounterTypepreferred (extensible)DAF Encounter Type
Encounter.participant.typeParticipantTypepreferred (extensible)ParticipantType
Encounter.reasonDAFEncounterReasonValuesetrequired (extensible)DAF Encounter Diagnoses
Encounter.priorityPriorityexample (extensible)Encounter Priority
Encounter.hospitalization.admitSourceAdmitSourcepreferred (extensible)AdmitSource
Encounter.hospitalization.dietPatientDietpreferred (extensible)Diet
Encounter.hospitalization.specialCourtesyCourtesiespreferred (extensible)SpecialCourtesy
Encounter.hospitalization.specialArrangementArrangementspreferred (extensible)SpecialArrangements
Encounter.hospitalization.dischargeDispositionDischargeDisppreferred (extensible)DischargeDisposition
Encounter.location.statusEncounterLocationStatusrequiredEncounterLocationStatus

Constraints

IdPathNameDetails
.