Validated Healthcare Directory
0.2.0 - CI Build

Validated Healthcare Directory, published by HL7 International - Patient Administration Work 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

Extension: VhDir Usage Restriction

The FHIR specification contains a security meta tag which can be used to inform systems of the sensitivity of resources, as well as by access control mechanisms to ensure content isn’t exposed that shouldn’t be. This mechanism only goes to the resource level, this reference to a usage-restriction (consent) extends this further into the resource, and can be applied to any element, and may apply to all properties beneath the element (e.g. If applied to an identifier on a practitioner, then all the properties of the identifier should not be exposed unless it is understood) This will be expected to be used as a modifier extension.

The official URL for this extension is:

http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction

Status: active
Extension maintained by: HL7 International - Patient Administration Work Group

Context of Use

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

  • descendants()

Background and Context

The FHIR specification contains a security meta tag which can be used to inform systems of the sensitivity of resources. The tag can be used by access control mechanisms to ensure content isn’t exposed inappropriately. However, the security meta tag can only indicate sensitivity at the resource level, and provides relatively little context about the restriction.

This implementation guide profiles the Consent resource to provide additional details about the nature of restricted content. This extension provides a reference to the VhDir Consent profile. It is available to all other profiles in this implementation guide.

This extension is typically expected to function as a reference to a contained resource.

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

Summary

Mandatory: 1 element
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRestriction
... url 1..1uri"http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction"
... value[x]:valueReference S1..1Reference(VhDir Restriction)Reference
.... identifier 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRestriction
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction"
... value[x]:valueReference S1..1Reference(VhDir Restriction)Reference
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... display Σ0..1stringText alternative for the resource

doco Documentation for this format

This structure is derived from Extension

Summary

Mandatory: 1 element
Must-Support: 1 element
Fixed Value: 1 element
Prohibited: 1 element

Structures

This structure refers to these other structures:

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRestriction
... url 1..1uri"http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction"
... value[x]:valueReference S1..1Reference(VhDir Restriction)Reference
.... identifier 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*ExtensionRestriction
... id 0..1stringUnique id for inter-element referencing
... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org/fhir/uv/vhdir/StructureDefinition/usage-restriction"
... value[x]:valueReference S1..1Reference(VhDir Restriction)Reference
.... id 0..1stringUnique id for inter-element referencing
.... Slices for extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... type Σ0..1uriType the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).

.... display Σ0..1stringText alternative for the resource

doco Documentation for this format

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet
Extension.value[x]:valueReference.typeextensibleResourceType

Notes: