VhDir Implementation Guide CI Build: STU2 Ballot

This page is part of the Validated Healthcare Directory FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR v3.5.0. . For a full list of available versions, see the Directory of published versions

StructureDefinition-ehr

An extension to describe the electronic health record (EHR) product(s) in use at a location.

Consists of:

  • ehr.developer - indicates the developer of the EHR product
  • ehr.product - indicates the name of the EHR product
  • ehr.version - indicates the version of the EHR product
  • ehr.certificationEdition - indicates whether the product has been certified, and to which certification edition
  • ehr.patientAccess - indicates whether the EHR product provides capabilities to support patient engagement
  • ehr.certificationID - A unique ID assigned by the ONC-authorized certification body (ONC-ACB) certifying the EHR product

Users should refer to the ONC Certified Health IT Product List (CHPL) for further guidance on describing the developer, product, and version of an EHR.

Formal Views of Profile Content

Description of Profiles, Differentials, and Snapshots.

The official URL for this profile is: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr

Published on Tue Nov 14 05:19:15 AEST 2017 as a active by .

This profile builds on Extension

Complete Summary of the Mandatory Requirements

This extension is optional. If used, it SHALL include a value in at least one of developer, product, certificationEdition, patientAccess, or certificationID

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*EHR
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension 0..1ExtensionDeveloper
.... url 1..1"developer"
.... valueString 1..1stringDeveloper
... extension 0..1ExtensionProduct
.... url 1..1"product"
.... valueString 1..1stringProduct
... extension 0..1Extensionversion
.... url 1..1"version"
.... valueString 1..1stringVersion
... extension 0..1ExtensionCertification edition
.... url 1..1"certificationEdition"
.... valueCoding 1..1CodingCertification edition
Binding: VhDir Certification Edition Value Set (example)
... extension 0..*ExtensionPatient acccess
.... url 1..1"patientAccess"
.... valueCodeableConcept 1..1CodeableConceptPatient access
Binding: VhDir Ehr Patient Access Value Set (example)
... extension 0..1ExtensionCertification ID
.... url 1..1"certificationID"
.... valueString 1..1stringCertification ID
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*EHR
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension 0..1ExtensionDeveloper
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"developer"
.... valueString 1..1stringDeveloper
... extension 0..1ExtensionProduct
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"product"
.... valueString 1..1stringProduct
... extension 0..1Extensionversion
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"version"
.... valueString 1..1stringVersion
... extension 0..1ExtensionCertification edition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificationEdition"
.... valueCoding 1..1CodingCertification edition
Binding: VhDir Certification Edition Value Set (example)
... extension 0..*ExtensionPatient acccess
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"patientAccess"
.... valueCodeableConcept 1..1CodeableConceptPatient access
Binding: VhDir Ehr Patient Access Value Set (example)
... extension 0..1ExtensionCertification ID
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificationID"
.... valueString 1..1stringCertification ID
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"

doco Documentation for this format

Summary

Mandatory: 0 element (6 nested mandatory elements)
Fixed Value: 7 elements
Prohibited: 1 element

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*EHR
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension 0..1ExtensionDeveloper
.... url 1..1"developer"
.... valueString 1..1stringDeveloper
... extension 0..1ExtensionProduct
.... url 1..1"product"
.... valueString 1..1stringProduct
... extension 0..1Extensionversion
.... url 1..1"version"
.... valueString 1..1stringVersion
... extension 0..1ExtensionCertification edition
.... url 1..1"certificationEdition"
.... valueCoding 1..1CodingCertification edition
Binding: VhDir Certification Edition Value Set (example)
... extension 0..*ExtensionPatient acccess
.... url 1..1"patientAccess"
.... valueCodeableConcept 1..1CodeableConceptPatient access
Binding: VhDir Ehr Patient Access Value Set (example)
... extension 0..1ExtensionCertification ID
.... url 1..1"certificationID"
.... valueString 1..1stringCertification ID
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*EHR
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension 0..1ExtensionDeveloper
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"developer"
.... valueString 1..1stringDeveloper
... extension 0..1ExtensionProduct
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"product"
.... valueString 1..1stringProduct
... extension 0..1Extensionversion
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"version"
.... valueString 1..1stringVersion
... extension 0..1ExtensionCertification edition
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificationEdition"
.... valueCoding 1..1CodingCertification edition
Binding: VhDir Certification Edition Value Set (example)
... extension 0..*ExtensionPatient acccess
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"patientAccess"
.... valueCodeableConcept 1..1CodeableConceptPatient access
Binding: VhDir Ehr Patient Access Value Set (example)
... extension 0..1ExtensionCertification ID
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificationID"
.... valueString 1..1stringCertification ID
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"

doco Documentation for this format

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


See the Conformance requirements for a complete list of supported RESTful interactions for this IG.