Validated Healthcare Directory IG STU1 Draft for Comment

This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR (HL7® FHIR® Standard) v3.2.0. The current version which supersedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: digitalCertificate - Content

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 - the base64 encoding of 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.

1.2 - Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate

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

This profile builds on Extension.

This profile was published on Tue Nov 14 03:51:52 AEDT 2017 as a draft by null.

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

Complete Summary of the Mandatory Requirements

  1. One type in digitalCertificate.type
  2. One base64 encoding of the certificate in digitalCertificate.certificate
  3. One date in digitalCertificate.expirationDate
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*digitalCertificate
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"
... value[x] 0..0
... extension 1..1ExtensionType
.... url 1..1uri"type"
.... valueCode 0..1codetype
... extension 0..*Extensionuse
.... url 1..1uri"use"
.... valueCode 0..1codeuse
... extension 0..1ExtensionCertificate standard
.... url 1..1uri"certificateStandard"
.... valueCode 0..1codeCertificate standard
... extension 1..1ExtensionCertificate
.... url 1..1uri"certificate"
.... valueBase64Binary 0..1base64BinaryCertificate
... extension 1..1ExtensionExpiration date
.... url 1..1uri"expirationDate"
.... valueDate 0..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... url 1..1uri"trustFramework"
.... valueCodeableConcept 0..1CodeableConceptTrust framework

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*digitalCertificate
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..1ExtensionType
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"type"
.... valueCode 0..1codetype
... extension 0..*Extensionuse
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"use"
.... valueCode 0..1codeuse
... extension 0..1ExtensionCertificate standard
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"certificateStandard"
.... valueCode 0..1codeCertificate standard
... extension 1..1ExtensionCertificate
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"certificate"
.... valueBase64Binary 0..1base64BinaryCertificate
... extension 1..1ExtensionExpiration date
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"expirationDate"
.... valueDate 0..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"trustFramework"
.... valueCodeableConcept 0..1CodeableConceptTrust framework
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"

doco Documentation for this format

Complete Summary of the Mandatory Requirements

  1. One type in digitalCertificate.type
  2. One base64 encoding of the certificate in digitalCertificate.certificate
  3. One date in digitalCertificate.expirationDate

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*digitalCertificate
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"
... value[x] 0..0
... extension 1..1ExtensionType
.... url 1..1uri"type"
.... valueCode 0..1codetype
... extension 0..*Extensionuse
.... url 1..1uri"use"
.... valueCode 0..1codeuse
... extension 0..1ExtensionCertificate standard
.... url 1..1uri"certificateStandard"
.... valueCode 0..1codeCertificate standard
... extension 1..1ExtensionCertificate
.... url 1..1uri"certificate"
.... valueBase64Binary 0..1base64BinaryCertificate
... extension 1..1ExtensionExpiration date
.... url 1..1uri"expirationDate"
.... valueDate 0..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... url 1..1uri"trustFramework"
.... valueCodeableConcept 0..1CodeableConceptTrust framework

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*digitalCertificate
... id 0..1stringxml:id (or equivalent in JSON)
... extension 1..1ExtensionType
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"type"
.... valueCode 0..1codetype
... extension 0..*Extensionuse
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"use"
.... valueCode 0..1codeuse
... extension 0..1ExtensionCertificate standard
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"certificateStandard"
.... valueCode 0..1codeCertificate standard
... extension 1..1ExtensionCertificate
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"certificate"
.... valueBase64Binary 0..1base64BinaryCertificate
... extension 1..1ExtensionExpiration date
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"expirationDate"
.... valueDate 0..1dateExpiration date
... extension 0..*ExtensionTrust framework
.... id 0..1stringxml:id (or equivalent in JSON)
.... url 1..1uri"trustFramework"
.... valueCodeableConcept 0..1CodeableConceptTrust framework
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/digitalCertificate"

doco Documentation for this format

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

 

1.3 - Quick Start

Below is an overview of the required search and read operations for this profile. See the Conformance requirements for the US Core Server for a complete list of supported RESTful operations and search parameters for this IG.

No Search criteria for digitalCertificate extension.