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 Digitalcertificate

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

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

A digital certificate, used to identify a user or group of users, or for encrypted communications

Context of Use

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

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

An extension to describe digital certificates.

Consists of:

  • digitalCertificate.type - indicates the type of digital certificate
  • digitalCertificate.use - indicates the purpose of the digital certificate
  • digitalCertificate.certificateStandard - indicates the certificate standard (currently only x.509v3 certificates are supported)
  • digitalCertificate.certificate - a string representation of a PEM format certificate, or a URI for locating the certificate
  • digitalCertificate.expirationDate - indicates when the certificate expires
  • digitalCertificate.trustFramework - indicates any trust frameworks supported by the certificate

digitalCertificate is an extension to the practitioner, organization, practitionerRole, and endpoint resources.

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 digital certificate
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type S 1..1 Extension Type
..... url 1..1 uri "type"
..... value[x] 1..1 Coding type
Binding: VhDir Digital Certificate Type Value Set (example)
.... extension:use S 0..* Extension Use
..... url 1..1 uri "use"
..... value[x] 1..1 Coding use
Binding: VhDir Digital Certificate Use Value Set (example)
.... extension:certificateStandard S 0..1 Extension Certificate standard
..... url 1..1 uri "certificateStandard"
..... value[x] 1..1 Coding Certificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
.... extension:certificate S 1..1 Extension Certificate
..... url 1..1 uri "certificate"
..... value[x] 1..1 Certificate
...... valueString string
...... valueUri uri
.... extension:expirationDate S 1..1 Extension Expiration date
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 date Expiration date
.... extension:trustFramework S 0..* Extension Trust framework
..... url 1..1 uri "trustFramework"
..... value[x] 1..1 CodeableConcept Trust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"
... value[x] S 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension digital certificate
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type S 1..1 Extension Type
..... 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 "type"
..... value[x] 1..1 Coding type
Binding: VhDir Digital Certificate Type Value Set (example)
.... extension:use S 0..* Extension Use
..... 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 "use"
..... value[x] 1..1 Coding use
Binding: VhDir Digital Certificate Use Value Set (example)
.... extension:certificateStandard S 0..1 Extension Certificate standard
..... 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 "certificateStandard"
..... value[x] 1..1 Coding Certificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
.... extension:certificate S 1..1 Extension Certificate
..... 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 "certificate"
..... value[x] 1..1 Certificate
...... valueString string
...... valueUri uri
.... extension:expirationDate S 1..1 Extension Expiration date
..... 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 "expirationDate"
..... value[x] 1..1 date Expiration date
.... extension:trustFramework S 0..* Extension Trust framework
..... 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 "trustFramework"
..... value[x] 1..1 CodeableConcept Trust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: A digital certificate, used to identify a user or group of users, or for encrypted communications

  • type: Coding: Type of digital certificate (TLS/SSL; device; identity; group)
  • use: Coding: Purpose of the digital certificate (digsig; keyEncipherment)
  • certificateStandard: Coding: The standard associated with the digital certificate (x.509v3)
  • certificate: string, uri: PEM format certificate (as a string) or URI for locating the certificate
  • expirationDate: date: Expiration date of the certificate
  • trustFramework: CodeableConcept: The trust framework(s) supported by the certificate (DirectTrust; FBCA; other)

Maturity: 2

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension digital certificate
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type S 1..1 Extension Type
..... url 1..1 uri "type"
..... value[x] 1..1 Coding type
Binding: VhDir Digital Certificate Type Value Set (example)
.... extension:use S 0..* Extension Use
..... url 1..1 uri "use"
..... value[x] 1..1 Coding use
Binding: VhDir Digital Certificate Use Value Set (example)
.... extension:certificateStandard S 0..1 Extension Certificate standard
..... url 1..1 uri "certificateStandard"
..... value[x] 1..1 Coding Certificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
.... extension:certificate S 1..1 Extension Certificate
..... url 1..1 uri "certificate"
..... value[x] 1..1 Certificate
...... valueString string
...... valueUri uri
.... extension:expirationDate S 1..1 Extension Expiration date
..... url 1..1 uri "expirationDate"
..... value[x] 1..1 date Expiration date
.... extension:trustFramework S 0..* Extension Trust framework
..... url 1..1 uri "trustFramework"
..... value[x] 1..1 CodeableConcept Trust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"
... value[x] S 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension digital certificate
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 3..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:type S 1..1 Extension Type
..... 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 "type"
..... value[x] 1..1 Coding type
Binding: VhDir Digital Certificate Type Value Set (example)
.... extension:use S 0..* Extension Use
..... 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 "use"
..... value[x] 1..1 Coding use
Binding: VhDir Digital Certificate Use Value Set (example)
.... extension:certificateStandard S 0..1 Extension Certificate standard
..... 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 "certificateStandard"
..... value[x] 1..1 Coding Certificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
.... extension:certificate S 1..1 Extension Certificate
..... 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 "certificate"
..... value[x] 1..1 Certificate
...... valueString string
...... valueUri uri
.... extension:expirationDate S 1..1 Extension Expiration date
..... 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 "expirationDate"
..... value[x] 1..1 date Expiration date
.... extension:trustFramework S 0..* Extension Trust framework
..... 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 "trustFramework"
..... value[x] 1..1 CodeableConcept Trust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1 uri "http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"

doco Documentation for this format

This structure is derived from Extension

Summary

Complex Extension: A digital certificate, used to identify a user or group of users, or for encrypted communications

  • type: Coding: Type of digital certificate (TLS/SSL; device; identity; group)
  • use: Coding: Purpose of the digital certificate (digsig; keyEncipherment)
  • certificateStandard: Coding: The standard associated with the digital certificate (x.509v3)
  • certificate: string, uri: PEM format certificate (as a string) or URI for locating the certificate
  • expirationDate: date: Expiration date of the certificate
  • trustFramework: CodeableConcept: The trust framework(s) supported by the certificate (DirectTrust; FBCA; other)

Maturity: 2

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSetURI
Extension.extension:type.value[x]exampleVhDirDigitalCertificateType
http://hl7.org/fhir/uv/vhdir/ValueSet/digitalcertificatetype
from this IG
Extension.extension:use.value[x]exampleVhDirDigitalCertificateUse
http://hl7.org/fhir/uv/vhdir/ValueSet/digitalcertificateuse
from this IG
Extension.extension:certificateStandard.value[x]requiredVhDirDigitalCertificateStandard
http://hl7.org/fhir/uv/vhdir/ValueSet/digitalcertificatestandard
from this IG
Extension.extension:trustFramework.value[x]exampleVhDirDigitalCertificateTrustFramework
http://hl7.org/fhir/uv/vhdir/ValueSet/digitalcertificatetrustframework
from this IG

Notes:

No Search criteria for digitalCertificate extension.