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 v3.2.0. . For a full list of available versions, see the Directory of published versions

1.0 - StructureDefinition: usage-restriction - Content

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. 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.target - indicates the resource(s), element(s), or combination thereof that the restriction applies to
  • usage-restriction.type - indicates the type of restriction (e.g. based on an item in a data use agreement)
  • usage-restriction.policy - indicates the policy defining the restriction
  • usage-restriction.status - indicates the status of the restriction (i.e. whether it is active)
  • usage-restriction.lastUpdated - indicates when the restriction was last updated
  • usage-restriction.retrospective - indicates whether the restriction is retrospective
  • usage-restriction.reason - indicates why the target is restricted
    • usage-restriction.reason.name - indicates the name of the restriction condition
    • usage-restriction.conditionalSource - Indicates whether information from another source is necessary to determine if something is restricted
    • usage-restriction.reasonType - indicates the type of restriction
  • usage-restriction.accessRights - defines a group/class of individuals/orgs to which the target is not restricted

Usage-restriction is expected to be used as a modifier extension.

Expected Implementations

1.2 - Formal Views of Profile Content

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.

Summary of the Mandatory Requirements and Key properties

  1. At least one target in restriction.target
  2. If indicating the reason for restriction:
  3. One name of the restriction in restriction.reason.name
  4. One conditional source in restriction.reason.conditionalSource
  5. At least one type of reason in restriction.reason.reasonType
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Restriction
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction"
... valueReference 0..1Reference(vhdir-restriction)Reference
.... identifier 0..0

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Restriction
... id 0..1stringxml:id (or equivalent in JSON)
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction"
... valueReference 0..1Reference(vhdir-restriction)Reference
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... display Σ0..1stringText alternative for the resource

doco Documentation for this format

Summary of the Mandatory Requirements and Key properties

  1. At least one target in restriction.target
  2. If indicating the reason for restriction:
  3. One name of the restriction in restriction.reason.name
  4. One conditional source in restriction.reason.conditionalSource
  5. At least one type of reason in restriction.reason.reasonType

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*Restriction
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction"
... valueReference 0..1Reference(vhdir-restriction)Reference
.... identifier 0..0

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*Restriction
... id 0..1stringxml:id (or equivalent in JSON)
... url 1..1uri"http://hl7.org/fhir/ig/vhdir/StructureDefinition/usage-restriction"
... valueReference 0..1Reference(vhdir-restriction)Reference
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... display Σ0..1stringText alternative for the resource

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.