VhDir

Validated Healthcare Directory, published by HL7 International - Patient Admistration Working Group. This is not an authorized publication; it is the continuous build for version 0.2.0). This version is based on the current content of https://github.com/HL7/VhDir/ and changes regularly. 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 Mon Nov 13 16:51:52 UTC 2017 as a active by .

This profile builds on Extension

Text Summary
Differential Table
Snapshot Table
All

Summary

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

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	digitalcertificate
extension		0..*	Extension	Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
url		1..1	uri	"type"
value[x]:valueCoding		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]:valueCoding		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]:valueCoding		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]:valueDate		1..1	date	Expiration date
extension:trustFramework	S	0..*	Extension	Trust framework
url		1..1	uri	"trustFramework"
value[x]:valueCodeableConcept		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
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	digitalcertificate
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	SI	1..1	Extension	Type
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"type"
value[x]:valueCoding	I	1..1	Coding	type Binding: VhDir Digital Certificate Type Value Set (example)
extension:use	SI	0..*	Extension	Use
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"use"
value[x]:valueCoding	I	1..1	Coding	use Binding: VhDir Digital Certificate Use Value Set (example)
extension:certificateStandard	SI	0..1	Extension	Certificate standard
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"certificateStandard"
value[x]:valueCoding	I	1..1	Coding	Certificate standard Binding: VhDir Digital Certificate Standard Value Set (required)
extension:certificate	SI	1..1	Extension	Certificate
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"certificate"
value[x]	I	1..1		Certificate
valueString			string
valueUri			uri
extension:expirationDate	SI	1..1	Extension	Expiration date
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"expirationDate"
value[x]:valueDate	I	1..1	date	Expiration date
extension:trustFramework	SI	0..*	Extension	Trust framework
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"trustFramework"
value[x]:valueCodeableConcept	I	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"
Documentation for this format

Summary

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

Differential View

Name	Flags	Card.	Type	Description & Constraints
Extension		0..*	Extension	digitalcertificate
extension		0..*	Extension	Slice: Unordered, Open by value:url
extension:type	S	1..1	Extension	Type
url		1..1	uri	"type"
value[x]:valueCoding		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]:valueCoding		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]:valueCoding		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]:valueDate		1..1	date	Expiration date
extension:trustFramework	S	0..*	Extension	Trust framework
url		1..1	uri	"trustFramework"
value[x]:valueCodeableConcept		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
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
Extension	I	0..*	Extension	digitalcertificate
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Extension Slice: Unordered, Open by value:url
extension:type	SI	1..1	Extension	Type
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"type"
value[x]:valueCoding	I	1..1	Coding	type Binding: VhDir Digital Certificate Type Value Set (example)
extension:use	SI	0..*	Extension	Use
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature			Signature
valueTiming			Timing
valueContactDetail			ContactDetail
valueContributor			Contributor
valueDataRequirement			DataRequirement
valueExpression			Expression
valueParameterDefinition			ParameterDefinition
valueRelatedArtifact			RelatedArtifact
valueTriggerDefinition			TriggerDefinition
valueUsageContext			UsageContext
valueDosage			Dosage
valueMeta			Meta
url		1..1	uri	"use"
value[x]:valueCoding	I	1..1	Coding	use Binding: VhDir Digital Certificate Use Value Set (example)
extension:certificateStandard	SI	0..1	Extension	Certificate standard
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
id		0..1	string	Unique id for inter-element referencing
extension	I	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
url		1..1	uri	identifies the meaning of the extension
value[x]	I	0..1		Value of extension
valueBase64Binary			base64Binary
valueBoolean			boolean
valueCanonical			canonical(Any)
valueCode			code
valueDate			date
valueDateTime			dateTime
valueDecimal			decimal
valueId			id
valueInstant			instant
valueInteger			integer
valueMarkdown			markdown
valueOid			oid
valuePositiveInt			positiveInt
valueString			string
valueTime			time
valueUnsignedInt			unsignedInt
valueUri			uri
valueUrl			url
valueUuid			uuid
valueAddress			Address
valueAge			Age
valueAnnotation			Annotation
valueAttachment			Attachment
valueCodeableConcept			CodeableConcept
valueCoding			Coding
valueContactPoint			ContactPoint
valueCount			Count
valueDistance			Distance
valueDuration			Duration
valueHumanName			HumanName
valueIdentifier			Identifier
valueMoney			Money
valuePeriod			Period
valueQuantity			Quantity
valueRange			Range
valueRatio			Ratio
valueReference			Reference(Any)
valueSampledData			SampledData
valueSignature