Standard Health Record FHIR Implementation Guide

SHR Encounter Profile

 

The official URL for this profile is:

http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-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, independent of the context of requested, planned, performed, etc.

This profile builds on Basic.

This profile was published on Wed Dec 20 00:00:00 EST 2017 as a draft by The MITRE Corporation: Standard Health Record Collaborative.

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

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.encounter.Encounter maps to Basic:

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR Encounter Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-encounter-Encounter"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-ActionContext-extension 1..1(Complex)SHR ActionContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ActionContext-extension
... shr-base-Subject-extension 0..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-encounter-ReferralDate-extension 0..1dateSHR ReferralDate Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralDate-extension
... shr-encounter-ReferralSourceType-extension 0..1CodeableConceptSHR ReferralSourceType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralSourceType-extension
Binding: SHR ReferralSourceTypeVS ValueSet (required)
... shr-core-TypeAsaCoding-extension 0..1CodingSHR TypeAsaCoding Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension
.... valueCoding Binding: ActEncounterCode (extensible)
... shr-encounter-ServiceGiven-extension 0..*CodeableConceptSHR ServiceGiven Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceGiven-extension
... shr-encounter-ServiceProvider-extension 0..1Reference(SHR Organization Profile)SHR ServiceProvider Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceProvider-extension
... shr-encounter-TreatmentCooperation-extension 0..1CodeableConceptSHR TreatmentCooperation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-TreatmentCooperation-extension
Binding: SHR TreatmentCooperationVS ValueSet (required)
... shr-encounter-PaymentSource-extension 0..1(Complex)SHR PaymentSource Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-PaymentSource-extension

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR Encounter Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-ActionContext-extension 1..1(Complex)SHR ActionContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ActionContext-extension
... shr-base-Subject-extension 0..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-encounter-ReferralDate-extension 0..1dateSHR ReferralDate Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralDate-extension
... shr-encounter-ReferralSourceType-extension 0..1CodeableConceptSHR ReferralSourceType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralSourceType-extension
Binding: SHR ReferralSourceTypeVS ValueSet (required)
... shr-core-TypeAsaCoding-extension 0..1CodingSHR TypeAsaCoding Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension"
.... valueCoding 1..1CodingValue of extension
Binding: ActEncounterCode (extensible)
... shr-encounter-ServiceGiven-extension 0..*CodeableConceptSHR ServiceGiven Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceGiven-extension
... shr-encounter-ServiceProvider-extension 0..1Reference(SHR Organization Profile)SHR ServiceProvider Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceProvider-extension
... shr-encounter-TreatmentCooperation-extension 0..1CodeableConceptSHR TreatmentCooperation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-TreatmentCooperation-extension
Binding: SHR TreatmentCooperationVS ValueSet (required)
... shr-encounter-PaymentSource-extension 0..1(Complex)SHR PaymentSource Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-PaymentSource-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-encounter-Encounter"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

Summary

Mandatory: 0 element (1 nested mandatory element)

Extensions

This structure refers to these extensions:

SHR Mapping Source

This structure represents the following SHR mapping definition:

shr.encounter.Encounter maps to Basic:

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic SHR Encounter Profile
... code Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-encounter-Encounter"}]}
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-ActionContext-extension 1..1(Complex)SHR ActionContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ActionContext-extension
... shr-base-Subject-extension 0..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-encounter-ReferralDate-extension 0..1dateSHR ReferralDate Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralDate-extension
... shr-encounter-ReferralSourceType-extension 0..1CodeableConceptSHR ReferralSourceType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralSourceType-extension
Binding: SHR ReferralSourceTypeVS ValueSet (required)
... shr-core-TypeAsaCoding-extension 0..1CodingSHR TypeAsaCoding Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension
.... valueCoding Binding: ActEncounterCode (extensible)
... shr-encounter-ServiceGiven-extension 0..*CodeableConceptSHR ServiceGiven Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceGiven-extension
... shr-encounter-ServiceProvider-extension 0..1Reference(SHR Organization Profile)SHR ServiceProvider Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceProvider-extension
... shr-encounter-TreatmentCooperation-extension 0..1CodeableConceptSHR TreatmentCooperation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-TreatmentCooperation-extension
Binding: SHR TreatmentCooperationVS ValueSet (required)
... shr-encounter-PaymentSource-extension 0..1(Complex)SHR PaymentSource Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-PaymentSource-extension

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Basic I0..*SHR Encounter Profile
... 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
... shr-base-RelatedEncounter-extension 0..1Reference(SHR EncounterPerformed Profile)SHR RelatedEncounter Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-RelatedEncounter-extension
... shr-base-Author-extension 0..1(Complex)SHR Author Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Author-extension
... shr-base-Informant-extension 0..1(Complex)SHR Informant Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Informant-extension
... shr-entity-Type-extension 0..1CodeableConceptSHR Type Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-entity-Type-extension
... shr-core-Category-extension 0..*CodeableConceptSHR Category Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-Category-extension
... shr-action-ActionContext-extension 1..1(Complex)SHR ActionContext Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-action-ActionContext-extension
... shr-base-Subject-extension 0..1(Complex)SHR Subject Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-base-Subject-extension
... shr-encounter-ReferralDate-extension 0..1dateSHR ReferralDate Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralDate-extension
... shr-encounter-ReferralSourceType-extension 0..1CodeableConceptSHR ReferralSourceType Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ReferralSourceType-extension
Binding: SHR ReferralSourceTypeVS ValueSet (required)
... shr-core-TypeAsaCoding-extension 0..1CodingSHR TypeAsaCoding Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"http://standardhealthrecord.org/fhir/StructureDefinition/shr-core-TypeAsaCoding-extension"
.... valueCoding 1..1CodingValue of extension
Binding: ActEncounterCode (extensible)
... shr-encounter-ServiceGiven-extension 0..*CodeableConceptSHR ServiceGiven Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceGiven-extension
... shr-encounter-ServiceProvider-extension 0..1Reference(SHR Organization Profile)SHR ServiceProvider Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-ServiceProvider-extension
... shr-encounter-TreatmentCooperation-extension 0..1CodeableConceptSHR TreatmentCooperation Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-TreatmentCooperation-extension
Binding: SHR TreatmentCooperationVS ValueSet (required)
... shr-encounter-PaymentSource-extension 0..1(Complex)SHR PaymentSource Extension
URL: http://standardhealthrecord.org/fhir/StructureDefinition/shr-encounter-PaymentSource-extension
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierBusiness identifier
... code ?!Σ1..1CodeableConceptKind of Resource
Binding: Basic Resource Types (example)
Required Pattern: {"coding":[{"system":"http://standardhealthrecord.org/fhir/basic-resource-type","code":"shr-encounter-Encounter"}]}
... subject Σ0..1Reference(Resource)Identifies the focus of this resource
... created Σ0..1dateWhen created
... author Σ0..1Reference(Practitioner), Reference(Patient), Reference(RelatedPerson)Who created

doco Documentation for this format

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

 

Terminology Bindings

PathNameConformanceValueSet
Basic.languageCommon LanguagesextensibleCommon Languages
Basic.extension.valueCodingActEncounterCodeextensibleActEncounterCode
Basic.codeBasic Resource TypesexampleBasic Resource Types

 

Constraints

IdPathDetailsRequirements
dom-2BasicIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-1BasicIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-4BasicIf 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-3BasicIf 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()