Current Build

​ D.4.1 StructureDefinition: fpar-genEncounter

​D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/fpar/StructureDefinition/fpar-genEncounter

This profile builds on Encounter.

This profile was published on Wed May 10 00:00:00 EDT 2017 as a draft by HSPC on behalf of FPAR.

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

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter
... reasonCancelled 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-reasonCancelled profiled by http://hl7.org/fhir/fpar/StructureDefinition/reasonCancelled
Binding: HSPC Reason Cancelled value set. (preferred)
... confidentiality 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-confidentiality profiled by http://hl7.org/fhir/fpar/StructureDefinition/confidentiality
Binding: v2 Confidentiality (preferred)
... hospitalService 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-hospitalService profiled by http://hl7.org/fhir/fpar/StructureDefinition/hospitalService
Binding: HSPC ProviderPractitioner Specialty (preferred)
... vipLevel 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-VipLevel profiled by http://hl7.org/fhir/fpar/StructureDefinition/vipLevel
Binding: http://hl7.org/fhir/fpar/ValueSet/hspc-viplevel (preferred)
... ambulatoryStatus 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AmbulatoryStatus profiled by http://hl7.org/fhir/fpar/StructureDefinition/ambulatoryStatus
Binding: v2 Ambulatory Status (preferred)
... departedByTransportation 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-departedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/departedByTransportation
Binding: HSPC Departure Transport Mode value set (preferred)
... arrivedByTransportation 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-arrivedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/arrivedByTransportation
Binding: HSPC Arrival Transport Mode value set (preferred)
... chiefComplaintId 0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-ChiefComplaintId profiled by http://hl7.org/fhir/fpar/StructureDefinition/chiefComplaintId
... admitMedicationId 0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdmitMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/admitMedicationId
... dischargeMedicationId 0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-DischargeMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/dischargeMedicationId
... communicationMode 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode
Binding: HSPC Communication Mode (preferred)
... administrativeEncounterId 0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdministrativeEncounterId profiled by http://hl7.org/fhir/fpar/StructureDefinition/administrativeEncounterId
... period 0..1Period
.... start 0..1The start time for the encounter
... length Slice: Ordered, Open by value:url
... length 0..0
... length 0..1Encoutner Length
.... system uriFixed Value: http://unitsofmeasure.org
.... code codeFixed Value: min
... location BackboneElementList of locations where the patient has been
Slice: Unordered, Open by value:url
... location 0..1Assigned Participating Location
.... extension 0..1CodeableConceptBinding: http://hl7.org/fhir/fpar/CodeSystem/arrivalStatus (preferred)
.... location Reference()
... location 0..1Service Delivery Location
.... extension 0..1CodeableConceptBinding: http://hl7.org/fhir/fpar/CodeSystem/locationCondition (preferred)
.... location Reference()

doco Documentation for this format

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*An interaction during which services are provided to the patient
... 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: Common Languages (extensible)
... 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
... confidentiality I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-confidentiality profiled by http://hl7.org/fhir/fpar/StructureDefinition/confidentiality
Binding: v2 Confidentiality (preferred)
ext-1: Must have either extensions or value[x], not both
... reasonCancelled I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-reasonCancelled profiled by http://hl7.org/fhir/fpar/StructureDefinition/reasonCancelled
Binding: HSPC Reason Cancelled value set. (preferred)
ext-1: Must have either extensions or value[x], not both
... hospitalService I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-hospitalService profiled by http://hl7.org/fhir/fpar/StructureDefinition/hospitalService
Binding: HSPC ProviderPractitioner Specialty (preferred)
ext-1: Must have either extensions or value[x], not both
... vipLevel I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-VipLevel profiled by http://hl7.org/fhir/fpar/StructureDefinition/vipLevel
Binding: http://hl7.org/fhir/fpar/ValueSet/hspc-viplevel (preferred)
ext-1: Must have either extensions or value[x], not both
... ambulatoryStatus I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AmbulatoryStatus profiled by http://hl7.org/fhir/fpar/StructureDefinition/ambulatoryStatus
Binding: v2 Ambulatory Status (preferred)
ext-1: Must have either extensions or value[x], not both
... departedByTransportation I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-departedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/departedByTransportation
Binding: HSPC Departure Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... arrivedByTransportation I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-arrivedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/arrivedByTransportation
Binding: HSPC Arrival Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... chiefComplaintId I0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-ChiefComplaintId profiled by http://hl7.org/fhir/fpar/StructureDefinition/chiefComplaintId
ext-1: Must have either extensions or value[x], not both
... admitMedicationId I0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdmitMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/admitMedicationId
ext-1: Must have either extensions or value[x], not both
... dischargeMedicationId I0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-DischargeMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/dischargeMedicationId
ext-1: Must have either extensions or value[x], not both
... communicationMode I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode
Binding: HSPC Communication Mode (preferred)
ext-1: Must have either extensions or value[x], not both
... administrativeEncounterId I0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdministrativeEncounterId profiled by http://hl7.org/fhir/fpar/StructureDefinition/administrativeEncounterId
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
... statusHistory I0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class Σ0..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
... classHistory I0..*BackboneElementList of past encounter classes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
.... period 1..1PeriodThe time that the episode was in the specified class
... type Σ0..*CodeableConceptSpecific type of encounter
Binding: EncounterType (example)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: HSPC Encounter Priority value set. (preferred)
... subject Σ0..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | Group)The patient or group present at the encounter
... episodeOfCare Σ0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(ReferralRequest)The ReferralRequest that initiated this encounter
... participant ΣI0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionAdditional Content defined by implementations
Binding: HSPC ProviderPractitioner Specialty (preferred)
ext-1: Must have either extensions or value[x], not both
.... 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 that the participant participated
.... individual Σ0..1Reference(Practitioner | RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ0..1Reference(Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
.... start 0..1The start time for the encounter
... length DurationQuantity of time the encounter lasted (less time absent)
Slice: Ordered, Open by value:url
... length 0..1DurationLength of Stay
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri

Fixed Value: http://unitsofmeasure.org
.... code 0..1codePrimitive Type code

Fixed Value: d
... length 0..1DurationEncounter Length
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri

Fixed Value: http://unitsofmeasure.org
.... code 0..1codePrimitive Type code

Fixed Value: min
... reason Σ0..*CodeableConceptReason the encounter takes place (code)
Binding: HSPC Encounter Reason (example)
... diagnosis ΣI0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... condition 1..1Reference(Condition | Procedure)Reason the encounter takes place (resource)
.... role 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge ???)
Binding: DiagnosisRole (preferred)
.... rank 0..1positiveIntRanking of the diagnosis (for each role type)
... account 0..*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..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptPreadmit test indicator
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... extension I0..*CodeableConceptExtension
ext-1: Must have either extensions or value[x], not both
.... 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: http://hl7.org/fhir/fpar/CodeSystem/admissionSource (example)
.... 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: v2 Re-Admission Indicator (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: HSPC Diet Type value set. (preferred)
.... 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 (example)
... location IBackboneElementList of locations where the patient has been
Slice: Unordered, Open by value:url
... location 0..1BackboneElementAssigned Participating Location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptExtension
Binding: http://hl7.org/fhir/fpar/CodeSystem/arrivalStatus (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference()A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... location 0..1BackboneElementService Delivery Location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptExtension
Binding: http://hl7.org/fhir/fpar/CodeSystem/locationCondition (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference()A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
.... id 0..1stringxml:id (or equivalent in JSON)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(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(Organization)The custodian organization of this Encounter record
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

Differential View

This structure is derived from Encounter

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter
... reasonCancelled 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-reasonCancelled profiled by http://hl7.org/fhir/fpar/StructureDefinition/reasonCancelled
Binding: HSPC Reason Cancelled value set. (preferred)
... confidentiality 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-confidentiality profiled by http://hl7.org/fhir/fpar/StructureDefinition/confidentiality
Binding: v2 Confidentiality (preferred)
... hospitalService 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-hospitalService profiled by http://hl7.org/fhir/fpar/StructureDefinition/hospitalService
Binding: HSPC ProviderPractitioner Specialty (preferred)
... vipLevel 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-VipLevel profiled by http://hl7.org/fhir/fpar/StructureDefinition/vipLevel
Binding: http://hl7.org/fhir/fpar/ValueSet/hspc-viplevel (preferred)
... ambulatoryStatus 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AmbulatoryStatus profiled by http://hl7.org/fhir/fpar/StructureDefinition/ambulatoryStatus
Binding: v2 Ambulatory Status (preferred)
... departedByTransportation 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-departedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/departedByTransportation
Binding: HSPC Departure Transport Mode value set (preferred)
... arrivedByTransportation 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-arrivedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/arrivedByTransportation
Binding: HSPC Arrival Transport Mode value set (preferred)
... chiefComplaintId 0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-ChiefComplaintId profiled by http://hl7.org/fhir/fpar/StructureDefinition/chiefComplaintId
... admitMedicationId 0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdmitMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/admitMedicationId
... dischargeMedicationId 0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-DischargeMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/dischargeMedicationId
... communicationMode 0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode
Binding: HSPC Communication Mode (preferred)
... administrativeEncounterId 0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdministrativeEncounterId profiled by http://hl7.org/fhir/fpar/StructureDefinition/administrativeEncounterId
... period 0..1Period
.... start 0..1The start time for the encounter
... length Slice: Ordered, Open by value:url
... length 0..0
... length 0..1Encoutner Length
.... system uriFixed Value: http://unitsofmeasure.org
.... code codeFixed Value: min
... location BackboneElementList of locations where the patient has been
Slice: Unordered, Open by value:url
... location 0..1Assigned Participating Location
.... extension 0..1CodeableConceptBinding: http://hl7.org/fhir/fpar/CodeSystem/arrivalStatus (preferred)
.... location Reference()
... location 0..1Service Delivery Location
.... extension 0..1CodeableConceptBinding: http://hl7.org/fhir/fpar/CodeSystem/locationCondition (preferred)
.... location Reference()

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Encounter I0..*An interaction during which services are provided to the patient
... 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: Common Languages (extensible)
... 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
... confidentiality I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-confidentiality profiled by http://hl7.org/fhir/fpar/StructureDefinition/confidentiality
Binding: v2 Confidentiality (preferred)
ext-1: Must have either extensions or value[x], not both
... reasonCancelled I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/extensions-reasonCancelled profiled by http://hl7.org/fhir/fpar/StructureDefinition/reasonCancelled
Binding: HSPC Reason Cancelled value set. (preferred)
ext-1: Must have either extensions or value[x], not both
... hospitalService I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-hospitalService profiled by http://hl7.org/fhir/fpar/StructureDefinition/hospitalService
Binding: HSPC ProviderPractitioner Specialty (preferred)
ext-1: Must have either extensions or value[x], not both
... vipLevel I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-VipLevel profiled by http://hl7.org/fhir/fpar/StructureDefinition/vipLevel
Binding: http://hl7.org/fhir/fpar/ValueSet/hspc-viplevel (preferred)
ext-1: Must have either extensions or value[x], not both
... ambulatoryStatus I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AmbulatoryStatus profiled by http://hl7.org/fhir/fpar/StructureDefinition/ambulatoryStatus
Binding: v2 Ambulatory Status (preferred)
ext-1: Must have either extensions or value[x], not both
... departedByTransportation I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-departedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/departedByTransportation
Binding: HSPC Departure Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... arrivedByTransportation I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-arrivedByTransportation profiled by http://hl7.org/fhir/fpar/StructureDefinition/arrivedByTransportation
Binding: HSPC Arrival Transport Mode value set (preferred)
ext-1: Must have either extensions or value[x], not both
... chiefComplaintId I0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-ChiefComplaintId profiled by http://hl7.org/fhir/fpar/StructureDefinition/chiefComplaintId
ext-1: Must have either extensions or value[x], not both
... admitMedicationId I0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdmitMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/admitMedicationId
ext-1: Must have either extensions or value[x], not both
... dischargeMedicationId I0..*Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-DischargeMedicationId profiled by http://hl7.org/fhir/fpar/StructureDefinition/dischargeMedicationId
ext-1: Must have either extensions or value[x], not both
... communicationMode I0..1CodeableConcept​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-CommunicationMode profiled by http://hl7.org/fhir/fpar/StructureDefinition/communicationMode
Binding: HSPC Communication Mode (preferred)
ext-1: Must have either extensions or value[x], not both
... administrativeEncounterId I0..1Identifier​Extension
URL: http://hl7.org/fhir/fpar/StructureDefinition/hspc-genencounter-AdministrativeEncounterId profiled by http://hl7.org/fhir/fpar/StructureDefinition/administrativeEncounterId
ext-1: Must have either extensions or value[x], not both
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifier(s) by which this encounter is known
... status ?!Σ1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
... statusHistory I0..*BackboneElementList of past encounter statuses
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... status 1..1codeplanned | arrived | triaged | in-progress | onleave | finished | cancelled +
Binding: EncounterStatus (required)
.... period 1..1PeriodThe time that the episode was in the specified status
... class Σ0..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
... classHistory I0..*BackboneElementList of past encounter classes
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... class 1..1Codinginpatient | outpatient | ambulatory | emergency +
Binding: ActEncounterCode (extensible)
.... period 1..1PeriodThe time that the episode was in the specified class
... type Σ0..*CodeableConceptSpecific type of encounter
Binding: EncounterType (example)
... priority 0..1CodeableConceptIndicates the urgency of the encounter
Binding: HSPC Encounter Priority value set. (preferred)
... subject Σ0..1Reference(http://hl7.org/fhir/fpar/StructureDefinition/hspc-patient | Group)The patient or group present at the encounter
... episodeOfCare Σ0..*Reference(EpisodeOfCare)Episode(s) of care that this encounter should be recorded against
... incomingReferral 0..*Reference(ReferralRequest)The ReferralRequest that initiated this encounter
... participant ΣI0..*BackboneElementList of participants involved in the encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..*ExtensionAdditional Content defined by implementations
Binding: HSPC ProviderPractitioner Specialty (preferred)
ext-1: Must have either extensions or value[x], not both
.... 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 that the participant participated
.... individual Σ0..1Reference(Practitioner | RelatedPerson)Persons involved in the encounter other than the patient
... appointment Σ0..1Reference(Appointment)The appointment that scheduled this encounter
... period 0..1PeriodThe start and end time of the encounter
.... start 0..1The start time for the encounter
... length DurationQuantity of time the encounter lasted (less time absent)
Slice: Ordered, Open by value:url
... length 0..1DurationLength of Stay
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri

Fixed Value: http://unitsofmeasure.org
.... code 0..1codePrimitive Type code

Fixed Value: d
... length 0..1DurationEncounter Length
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... value Σ0..1decimalNumerical value (with implicit precision)
.... comparator ?!Σ0..1code< | <= | >= | > - how to understand the value
Binding: QuantityComparator (required)
.... unit Σ0..1stringUnit representation
.... system 0..1uriPrimitive Type uri

Fixed Value: http://unitsofmeasure.org
.... code 0..1codePrimitive Type code

Fixed Value: min
... reason Σ0..*CodeableConceptReason the encounter takes place (code)
Binding: HSPC Encounter Reason (example)
... diagnosis ΣI0..*BackboneElementThe list of diagnosis relevant to this encounter
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... condition 1..1Reference(Condition | Procedure)Reason the encounter takes place (resource)
.... role 0..1CodeableConceptRole that this diagnosis has within the encounter (e.g. admission, billing, discharge ???)
Binding: DiagnosisRole (preferred)
.... rank 0..1positiveIntRanking of the diagnosis (for each role type)
... account 0..*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..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptPreadmit test indicator
Binding: v2 Yes/no Indicator (preferred)
ext-1: Must have either extensions or value[x], not both
.... extension I0..*CodeableConceptExtension
ext-1: Must have either extensions or value[x], not both
.... 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: http://hl7.org/fhir/fpar/CodeSystem/admissionSource (example)
.... 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: v2 Re-Admission Indicator (example)
.... dietPreference 0..*CodeableConceptDiet preferences reported by the patient
Binding: HSPC Diet Type value set. (preferred)
.... 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 (example)
... location IBackboneElementList of locations where the patient has been
Slice: Unordered, Open by value:url
... location 0..1BackboneElementAssigned Participating Location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptExtension
Binding: http://hl7.org/fhir/fpar/CodeSystem/arrivalStatus (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference()A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
... location 0..1BackboneElementService Delivery Location
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension I0..1CodeableConceptExtension
Binding: http://hl7.org/fhir/fpar/CodeSystem/locationCondition (preferred)
ext-1: Must have either extensions or value[x], not both
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference()A reference from one resource to another
.... status 0..1codeplanned | active | reserved | completed
Binding: EncounterLocationStatus (required)
.... period 0..1PeriodTime period during which the patient was present at the location
.... id 0..1stringxml:id (or equivalent in JSON)
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... location 1..1Reference(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(Organization)The custodian organization of this Encounter record
... partOf 0..1Reference(Encounter)Another Encounter this encounter is part of

doco Documentation for this format

 

​D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Encounter.languageCommon LanguagesextensibleCommon Languages
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.extensionHSPC Communication ModepreferredHSPC Communication Mode
Encounter.statusEncounterStatusrequiredEncounterStatus
Encounter.statusHistory.statusEncounterStatusrequiredEncounterStatus
Encounter.classActEncounterCodeextensibleActEncounterCode
Encounter.classHistory.classActEncounterCodeextensibleActEncounterCode
Encounter.typeEncounterTypeexampleEncounterType
Encounter.priorityHSPC Encounter Priority value set.preferredHSPC Encounter Priority value set.
Encounter.participant.extension
[]		HSPC ProviderPractitioner SpecialtypreferredHSPC ProviderPractitioner Specialty
Encounter.participant.typeParticipantTypeextensibleParticipantType
Encounter.length.comparatorQuantityComparatorrequiredQuantityComparator
Encounter.length.comparatorQuantityComparatorrequiredQuantityComparator
Encounter.reasonHSPC Encounter ReasonexampleHSPC Encounter Reason
Encounter.diagnosis.roleDiagnosisRolepreferredDiagnosisRole
Encounter.hospitalization.extensionv2 Yes/no Indicatorpreferredv2 Yes/no Indicator
Encounter.hospitalization.admitSource?extexamplehttp://hl7.org/fhir/fpar/CodeSystem/admissionSource
Encounter.hospitalization.reAdmissionv2 Re-Admission Indicatorexamplev2 Re-Admission Indicator
Encounter.hospitalization.dietPreferenceHSPC Diet Type value set.preferredHSPC Diet Type value set.
Encounter.hospitalization.specialCourtesySpecialCourtesypreferredSpecialCourtesy
Encounter.hospitalization.specialArrangementSpecialArrangementspreferredSpecialArrangements
Encounter.hospitalization.dischargeDispositionDischargeDispositionexampleDischargeDisposition
Encounter.location.extension?extpreferredhttp://hl7.org/fhir/fpar/CodeSystem/locationCondition
Encounter.location.statusEncounterLocationStatusrequiredEncounterLocationStatus
Encounter.location.extension?extpreferredhttp://hl7.org/fhir/fpar/CodeSystem/locationCondition
Encounter.location.statusEncounterLocationStatusrequiredEncounterLocationStatus
Encounter.location.statusEncounterLocationStatusrequiredEncounterLocationStatus

​D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2EncounterIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1EncounterIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4EncounterIf 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-3EncounterIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
: contained.where(('#'+id in %resource.descendants().reference).not()).empty()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.statusHistoryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Encounter.classHistoryAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Encounter.participantAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Encounter.participant.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ele-1Encounter.diagnosisAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ele-1Encounter.hospitalizationAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
ext-1Encounter.hospitalization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.hospitalization.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.location.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
ext-1Encounter.location.extensionMust have either extensions or value[x], not both
: extension.exists() != value.exists()
.