National Healthcare Directory Query
1.0.0-ballot - ballot

National Healthcare Directory Query, published by HL7 International - Patient Administration Work Group. This is not an authorized publication; it is the continuous build for version 1.0.0-ballot). This version is based on the current content of https://github.com/HL7/fhir-directory-query/ and changes regularly. See the Directory of published versions

## Extension: NatlDir Usage Restriction

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction | Version: 1.0.0-ballot
Active as of 2017-10-20 | Computable Name: UsageRestriction

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.

Context of Use

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

- Element ID

Usage info

Usage:

- Use this Extension: National Directory Endpoint Qry Care Team
- Examples for this Extension: CareTeam/CareTeam1

### Formal Views of Extension Content

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

- Text Summary
- Differential Table
- Snapshot Table
- All

This structure is derived from Extension

Summary

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

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Restriction (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDir-Restriction)

Slices

This structure defines the following Slices:

- The element Extension.value[x] is sliced based on the value of type:$this

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Restriction
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction"
value[x] |  | 1..1 | Reference() | Value of extension Slice: Unordered, Open by type:$this
valueReference | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Restriction) | Reference
identifier |  | 0..0 |  |
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Restriction
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction"
Slices for value[x] |  | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Restriction) | Reference
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
display | Σ | 0..1 | string | Text alternative for the resource
Documentation for this format

This structure is derived from Extension

Summary

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

Structures

This structure refers to these other structures:

- National Directory Endpoint Qry Exchange Restriction (http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDir-Restriction)

Slices

This structure defines the following Slices:

- The element Extension.value[x] is sliced based on the value of type:$this

Differential View

This structure is derived from Extension

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Restriction
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction"
value[x] |  | 1..1 | Reference() | Value of extension Slice: Unordered, Open by type:$this
valueReference | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Restriction) | Reference
identifier |  | 0..0 |  |
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Extension |  | 0..* | Extension | Restriction
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/us/directory-query/StructureDefinition/usage-restriction"
Slices for value[x] |  | 1..1 | Reference() | Value of extension Slice: Unordered, Closed by type:$this
value[x]:valueReference | S | 1..1 | Reference(National Directory Endpoint Qry Exchange Restriction) | Reference
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
display | Σ | 0..1 | string | Text alternative for the resource
Documentation for this format

Other representations of profile: CSV, Excel, Schematron

#### Terminology Bindings

Path | Conformance | ValueSet
Extension.value[x]:valueReference.type | extensible | ResourceType