This page is part of the Validated Healthcare Directory FHIR IG (v0.1.0: STU 1 Draft) based on FHIR v3.2.0. . For a full list of available versions, see the Directory of published versions
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. We propose a new mechanism, usage-restriction, that extends the concept of restriction further into an individual resource, while providing additional information about the restriction itself.
Useage-restriction can be applied to a resource, element, or combination thereof. If applied to a resource/element, the restriction is understood to apply to all of the properties of that resource/element, unless otherwise specified (e.g. if applied to an identifier on a practitioner, then all of the properties of that identifier are restricted)
It consists of:
Usage-restriction is expected to be used as a modifier extension.
The official URL for this profile is:
http://hl7.org/fhir/ig/vhdir/StructureDefinition/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.
This profile builds on Extension.
This profile was published on Fri Oct 20 10:59:36 AEDT 2017 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
restriction.target
restriction.reason.name
restriction.reason.conditionalSource
restriction.reason.reasonType
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Restriction | ||
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction" | |
valueReference | 0..1 | Reference(vhdir-restriction) | Reference | |
identifier | 0..0 | |||
Documentation for this format |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | I | 0..* | Restriction | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction" | |
valueReference | 0..1 | Reference(vhdir-restriction) | Reference | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
display | Σ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
restriction.target
restriction.reason.name
restriction.reason.conditionalSource
restriction.reason.reasonType
Differential View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | 0..* | Restriction | ||
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction" | |
valueReference | 0..1 | Reference(vhdir-restriction) | Reference | |
identifier | 0..0 | |||
Documentation for this format |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Extension | I | 0..* | Restriction | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
url | 1..1 | uri | "http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction" | |
valueReference | 0..1 | Reference(vhdir-restriction) | Reference | |
id | 0..1 | string | xml:id (or equivalent in JSON) | |
reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
display | Σ | 0..1 | string | Text alternative for the resource |
Documentation for this format |
Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron
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.