International Patient Access
0.1.0 - draft

International Patient Access, published by HL7. This is not an authorized publication; it is the continuous build for version 0.1.0). This version is based on the current content of https://github.com/grahamegrieve/ipa-candidate/ and changes regularly. See the Directory of published versions

StructureDefinition: IPAEncounter

Minimum expectations for an Encounter resource when accessed via a International Patient Access API

The official URL for this profile is:

http://hl7.org/fhir/uv/ipa/StructureDefinition/ipa-encounter

Formal Views of Profile Content

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

This structure is derived from Encounter

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!SΣI1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
... statusHistory I0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status I1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
.... period I1..1PeriodThe time that the episode was in the specified status
... class SΣI1..1CodingClassification of patient encounter
Binding: V3 Value SetActEncounterCode (extensible)
... classHistory I0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class I1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: V3 Value SetActEncounterCode (extensible)
.... period I1..1PeriodThe time that the episode was in the specified class
... type SΣI0..*CodeableConceptSpecific type of encounter
Binding: EncounterType (example)
... serviceType ΣI0..1CodeableConceptSpecific type of service
Binding: ServiceType (example)
... priority I0..1CodeableConceptIndicates the urgency of the encounter
Binding: v3 Code System ActPriority (example)
... subject SΣI1..1Reference(IPA-Patient)The patient or group present at the encounter
... episodeOfCare ΣI0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... basedOn I0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... participant ΣI0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period I0..1PeriodPeriod of time during the encounter that the participant participated
.... individual ΣI0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment ΣI0..*Reference(Appointment)The appointment that scheduled this encounter
... period SI0..1PeriodThe start and end time of the encounter
... length I0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode ΣI0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred)
... reasonReference ΣI0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis ΣI0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition ΣI1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use I0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred)
.... rank I0..1positiveIntRanking of the diagnosis (for each role type)
... account I0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
... hospitalization I0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier I0..1IdentifierPre-admission identifier
.... origin I0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource I0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... reAdmission I0..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: v2 RE-ADMISSION INDICATOR (example)
.... dietPreference I0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy I0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement I0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination I0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition I0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example)
... location I0..*BackboneElementList of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location I1..1Reference(Location)Location the encounter takes place
.... status I0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... physicalType I0..1CodeableConceptThe physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example)
.... period I0..1PeriodTime period during which the patient was present at the location
... serviceProvider I0..1Reference(Organization)The organization (facility) responsible for this encounter
... partOf I0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

This structure is derived from Encounter

Summary

Mandatory: 3 elements
Must-Support: 5 elements

Structures

This structure refers to these other structures:

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*EncounterAn interaction during which services are provided to the patient
... id Σ0..1stringLogical id of this artifact
... meta ΣI0..1MetaMetadata about the resource
... implicitRules ?!ΣI0..1uriA set of rules under which this content was created
... language I0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred)
Max Binding: AllLanguages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension I0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!I0..*ExtensionExtensions that cannot be ignored
... identifier ΣI0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!SΣI1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
... statusHistory I0..*BackboneElementList of past encounter statuses
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... status I1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
.... period I1..1PeriodThe time that the episode was in the specified status
... class SΣI1..1CodingClassification of patient encounter
Binding: V3 Value SetActEncounterCode (extensible)
... classHistory I0..*BackboneElementList of past encounter classes
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... class I1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: V3 Value SetActEncounterCode (extensible)
.... period I1..1PeriodThe time that the episode was in the specified class
... type SΣI0..*CodeableConceptSpecific type of encounter
Binding: EncounterType (example)
... serviceType ΣI0..1CodeableConceptSpecific type of service
Binding: ServiceType (example)
... priority I0..1CodeableConceptIndicates the urgency of the encounter
Binding: v3 Code System ActPriority (example)
... subject SΣI1..1Reference(IPA-Patient)The patient or group present at the encounter
... episodeOfCare ΣI0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... basedOn I0..*Reference(ServiceRequest)The ServiceRequest that initiated this encounter
... participant ΣI0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type ΣI0..*CodeableConceptRole of participant in encounter
Binding: ParticipantType (extensible)
.... period I0..1PeriodPeriod of time during the encounter that the participant participated
.... individual ΣI0..1Reference(Practitioner | PractitionerRole | RelatedPerson)Persons involved in the encounter other than the patient
... appointment ΣI0..*Reference(Appointment)The appointment that scheduled this encounter
... period SI0..1PeriodThe start and end time of the encounter
... length I0..1DurationQuantity of time the encounter lasted (less time absent)
... reasonCode ΣI0..*CodeableConceptCoded reason the encounter takes place
Binding: EncounterReasonCodes (preferred)
... reasonReference ΣI0..*Reference(Condition | Procedure | Observation | ImmunizationRecommendation)Reason the encounter takes place (reference)
... diagnosis ΣI0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition ΣI1..1Reference(Condition | Procedure)The diagnosis or procedure relevant to the encounter
.... use I0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge …)
Binding: DiagnosisRole (preferred)
.... rank I0..1positiveIntRanking of the diagnosis (for each role type)
... account I0..*Reference(Account)The set of accounts that may be used for billing for this Encounter
... hospitalization I0..1BackboneElementDetails about the admission to a healthcare service
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... preAdmissionIdentifier I0..1IdentifierPre-admission identifier
.... origin I0..1Reference(Location | Organization)The location/organization from which the patient came before admission
.... admitSource I0..1CodeableConceptFrom where patient was admitted (physician referral, transfer)
Binding: AdmitSource (preferred)
.... reAdmission I0..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: v2 RE-ADMISSION INDICATOR (example)
.... dietPreference I0..*CodeableConceptDiet preferences reported by the patient
Binding: Diet (example)
.... specialCourtesy I0..*CodeableConceptSpecial courtesies (VIP, board member)
Binding: SpecialCourtesy (preferred)
.... specialArrangement I0..*CodeableConceptWheelchair, translator, stretcher, etc.
Binding: SpecialArrangements (preferred)
.... destination I0..1Reference(Location | Organization)Location/organization to which the patient is discharged
.... dischargeDisposition I0..1CodeableConceptCategory or kind of location after discharge
Binding: DischargeDisposition (example)
... location I0..*BackboneElementList of locations where the patient has been
.... id 0..1stringUnique id for inter-element referencing
.... extension I0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!ΣI0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... location I1..1Reference(Location)Location the encounter takes place
.... status I0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... physicalType I0..1CodeableConceptThe physical type of the location (usually the level in the location hierachy - bed room ward etc.)
Binding: LocationType (example)
.... period I0..1PeriodTime period during which the patient was present at the location
... serviceProvider I0..1Reference(Organization)The organization (facility) responsible for this encounter
... partOf I0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

 

Other representations of profile: Schematron

Terminology Bindings

Terminology Bindings

PathConformanceValueSet
Encounter.languagepreferredCommonLanguages
Max Binding: AllLanguages
Encounter.statusrequiredEncounterStatus
Encounter.statusHistory.statusrequiredEncounterStatus
Encounter.classextensiblev3.ActEncounterCode
Encounter.classHistory.classextensiblev3.ActEncounterCode
Encounter.typeexampleEncounterType
Encounter.serviceTypeexampleServiceType
Encounter.priorityexamplev3.ActPriority
Encounter.participant.typeextensibleParticipantType
Encounter.reasonCodepreferredEncounterReasonCodes
Encounter.diagnosis.usepreferredDiagnosisRole
Encounter.hospitalization.admitSourcepreferredAdmitSource
Encounter.hospitalization.reAdmissionexamplev2.0092
Encounter.hospitalization.dietPreferenceexampleDiet
Encounter.hospitalization.specialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementpreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionexampleDischargeDisposition
Encounter.location.statusrequiredEncounterLocationStatus
Encounter.location.physicalTypeexampleLocationType

Constraints

Constraints

IdPathDetailsRequirements