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-digitalcertificate

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.

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/digitalcertificate

Published on Tue Nov 14 02:51:52 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:

  1. One type in digitalCertificate.type
  2. One PEM format certificate (as a string), or a URI indicating where to find the certificate in digitalCertificate.certificate
  3. One date in digitalCertificate.expirationDate
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*digitalcertificate
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension 1..1ExtensionType
.... url 1..1"type"
.... valueCoding 1..1Codingtype
Binding: VhDir Digital Certificate Type Value Set (example)
... extension 0..*ExtensionUse
.... url 1..1"use"
.... valueCoding 1..1Codinguse
Binding: VhDir Digital Certificate Use Value Set (example)
... extension 0..1ExtensionCertificate standard
.... url 1..1"certificateStandard"
.... valueCoding 1..1CodingCertificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
... extension 1..1ExtensionCertificate
.... url 1..1"certificate"
.... value[x] 1..1string, uriCertificate
... extension 1..1ExtensionExpiration date
.... url 1..1"expirationDate"
.... valueDate 1..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... url 1..1"trustFramework"
.... valueCodeableConcept 1..1CodeableConceptTrust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"
... value[x] 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*digitalcertificate
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension 1..1ExtensionType
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"type"
.... valueCoding 1..1Codingtype
Binding: VhDir Digital Certificate Type Value Set (example)
... extension 0..*ExtensionUse
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"use"
.... valueCoding 1..1Codinguse
Binding: VhDir Digital Certificate Use Value Set (example)
... extension 0..1ExtensionCertificate standard
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificateStandard"
.... valueCoding 1..1CodingCertificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
... extension 1..1ExtensionCertificate
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificate"
.... value[x] 1..1string, uriCertificate
... extension 1..1ExtensionExpiration date
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"expirationDate"
.... valueDate 1..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"trustFramework"
.... valueCodeableConcept 1..1CodeableConceptTrust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"

doco Documentation for this format

Summary

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

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*digitalcertificate
... extension 0..*ExtensionSlice: Unordered, Open by value:url
... extension 1..1ExtensionType
.... url 1..1"type"
.... valueCoding 1..1Codingtype
Binding: VhDir Digital Certificate Type Value Set (example)
... extension 0..*ExtensionUse
.... url 1..1"use"
.... valueCoding 1..1Codinguse
Binding: VhDir Digital Certificate Use Value Set (example)
... extension 0..1ExtensionCertificate standard
.... url 1..1"certificateStandard"
.... valueCoding 1..1CodingCertificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
... extension 1..1ExtensionCertificate
.... url 1..1"certificate"
.... value[x] 1..1string, uriCertificate
... extension 1..1ExtensionExpiration date
.... url 1..1"expirationDate"
.... valueDate 1..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... url 1..1"trustFramework"
.... valueCodeableConcept 1..1CodeableConceptTrust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"
... value[x] 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*digitalcertificate
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
... extension 1..1ExtensionType
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"type"
.... valueCoding 1..1Codingtype
Binding: VhDir Digital Certificate Type Value Set (example)
... extension 0..*ExtensionUse
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"use"
.... valueCoding 1..1Codinguse
Binding: VhDir Digital Certificate Use Value Set (example)
... extension 0..1ExtensionCertificate standard
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificateStandard"
.... valueCoding 1..1CodingCertificate standard
Binding: VhDir Digital Certificate Standard Value Set (required)
... extension 1..1ExtensionCertificate
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"certificate"
.... value[x] 1..1string, uriCertificate
... extension 1..1ExtensionExpiration date
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"expirationDate"
.... valueDate 1..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... url 1..1"trustFramework"
.... valueCodeableConcept 1..1CodeableConceptTrust framework
Binding: VhDir Digital Certificate Trust Framework Value Set (example)
... url 1..1"http://hl7.org/fhir/uv/vhdir/StructureDefinition/digitalcertificate"

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.