Validated Healthcare Directory
1.0.0 - STU1 International flag

This page is part of the Validated Healthcare Directory FHIR IG (v1.0.0: STU1) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version. For a full list of available versions, see the Directory of published versions

Extension: VhDir Ehr

Official URL: http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr Version: 1.0.0
Standards status: Trial-use Maturity Level: 2 Computable Name: EHR

Copyright/Legal: Used by permission of HL7 International all rights reserved Creative Commons License

Information about the EHR system/module used at a location

Context of Use

This extension may be used on the following element(s):

This extension may be used on the following element(s):

    This extension may be used on the following element(s):

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.

Usage info

Usage:

Formal Views of Extension Content

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

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension EHR
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:developer S 0..1 Extension Developer
..... url 1..1 uri "developer"
..... value[x] 1..1 string Developer
.... extension:product S 0..1 Extension Product
..... url 1..1 uri "product"
..... value[x] 1..1 string Product
.... extension:version S 0..1 Extension version
..... url 1..1 uri "version"
..... value[x] 1..1 string Version
.... extension:certificationEdition S 0..1 Extension Certification edition
..... url 1..1 uri "certificationEdition"
..... value[x] 1..1 Coding Certification edition
Binding: VhDir Certification Edition Value Set (example)
.... extension:patientAccess S 0..* Extension Patient acccess
..... url 1..1 uri "patientAccess"
..... value[x] 1..1 CodeableConcept Patient access
Binding: VhDir Ehr Patient Access Value Set (example)
.... extension:certificationID S 0..1 Extension Certification ID
..... url 1..1 uri "certificationID"
..... value[x] 1..1 string Certification ID
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"
... value[x] S 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension EHR
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:developer S 0..1 Extension Developer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "developer"
..... value[x] 1..1 string Developer
.... extension:product S 0..1 Extension Product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "product"
..... value[x] 1..1 string Product
.... extension:version S 0..1 Extension version
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "version"
..... value[x] 1..1 string Version
.... extension:certificationEdition S 0..1 Extension Certification edition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "certificationEdition"
..... value[x] 1..1 Coding Certification edition
Binding: VhDir Certification Edition Value Set (example)
.... extension:patientAccess S 0..* Extension Patient acccess
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "patientAccess"
..... value[x] 1..1 CodeableConcept Patient access
Binding: VhDir Ehr Patient Access Value Set (example)
.... extension:certificationID S 0..1 Extension Certification ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "certificationID"
..... value[x] 1..1 string Certification ID
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Information about the EHR system/module used at a location

  • developer: string: The developer of the EHR product
  • product: string: The name of the EHR product
  • version: string: Version of the EHR product
  • certificationEdition: Coding: Latest EHR certification criteria the EHR product has been certified against (2011, 2014, 2015)
  • patientAccess: CodeableConcept: Patient/consumer access options associated with the EHR product; a value indicates that the EHR has the capability and is actively using it
  • certificationID: string: Unique ID assigned by the ONC-authorized certification body (ONC-ACB) certifying this product

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension EHR
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:developer S 0..1 Extension Developer
..... url 1..1 uri "developer"
..... value[x] 1..1 string Developer
.... extension:product S 0..1 Extension Product
..... url 1..1 uri "product"
..... value[x] 1..1 string Product
.... extension:version S 0..1 Extension version
..... url 1..1 uri "version"
..... value[x] 1..1 string Version
.... extension:certificationEdition S 0..1 Extension Certification edition
..... url 1..1 uri "certificationEdition"
..... value[x] 1..1 Coding Certification edition
Binding: VhDir Certification Edition Value Set (example)
.... extension:patientAccess S 0..* Extension Patient acccess
..... url 1..1 uri "patientAccess"
..... value[x] 1..1 CodeableConcept Patient access
Binding: VhDir Ehr Patient Access Value Set (example)
.... extension:certificationID S 0..1 Extension Certification ID
..... url 1..1 uri "certificationID"
..... value[x] 1..1 string Certification ID
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"
... value[x] S 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension EHR
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:developer S 0..1 Extension Developer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "developer"
..... value[x] 1..1 string Developer
.... extension:product S 0..1 Extension Product
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "product"
..... value[x] 1..1 string Product
.... extension:version S 0..1 Extension version
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "version"
..... value[x] 1..1 string Version
.... extension:certificationEdition S 0..1 Extension Certification edition
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "certificationEdition"
..... value[x] 1..1 Coding Certification edition
Binding: VhDir Certification Edition Value Set (example)
.... extension:patientAccess S 0..* Extension Patient acccess
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "patientAccess"
..... value[x] 1..1 CodeableConcept Patient access
Binding: VhDir Ehr Patient Access Value Set (example)
.... extension:certificationID S 0..1 Extension Certification ID
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... url 1..1 uri "certificationID"
..... value[x] 1..1 string Certification ID
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/ehr"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: Information about the EHR system/module used at a location

  • developer: string: The developer of the EHR product
  • product: string: The name of the EHR product
  • version: string: Version of the EHR product
  • certificationEdition: Coding: Latest EHR certification criteria the EHR product has been certified against (2011, 2014, 2015)
  • patientAccess: CodeableConcept: Patient/consumer access options associated with the EHR product; a value indicates that the EHR has the capability and is actively using it
  • certificationID: string: Unique ID assigned by the ONC-authorized certification body (ONC-ACB) certifying this product

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:certificationEdition.value[x]exampleVhDirCertificationEdition
http://hl7.org/fhir/uv/vhdir/ValueSet/certificationedition
from this IG
Extension.extension:patientAccess.value[x]exampleVhDirEHRPatientAccess
http://hl7.org/fhir/uv/vhdir/ValueSet/patientaccess
from this IG

Notes:

No Search criteria for ehr extension.