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

## Resource Profile: National Directory Endpoint Qry Exchange Restriction

Official URL: http://hl7.org/fhir/us/directory-query/StructureDefinition/NatlDir-Restriction | Version: 1.0.0-ballot
Active as of 2017-12-15 | Computable Name: NatlDirRestriction

Restriction on use/release of exchanged information

Usage:

- Refer to this Resource Profile:
- Examples for this Resource Profile: Consent/PatientConsent

### Formal Views of Profile Content

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

- Differential Table
- Key Elements Table
- Snapshot Table
- Statistics/References
- All

This structure is derived from Consent

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent |  | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
identifier | S | 0..0 |  |
status | S | 1..1 | code | Indicates the current state of this restriction
scope | S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S | 1..* | CodeableConcept | Type of restriction
patient | S | 0..0 |  |
dateTime | S | 0..1 | dateTime | date/time of last update for this restriction
performer | S | 0..0 |  |
organization | S | 0..0 |  |
source[x] | S | 0..0 |  |
policy | S | 0..* | BackboneElement | Policies covered by this consent
authority | S | 0..0 |  |
uri | S | 0..1 | uri | Specific policy covered by this restriction
policyRule | S | 0..1 | CodeableConcept | Regulation that this consents to
verification | S | 0..0 |  |
provision | S | 0..1 | BackboneElement | Access rights
type | S | 0..1 | code | deny | permit Fixed Value: permit
period | S | 0..0 |  |
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
role | S | 1..1 | CodeableConcept | How the actor is involved
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S | 0..1 | CodeableConcept | reasonType
securityLabel | S | 0..* | Coding | userType
purpose | S | 0..* | Coding | reasonName
class | S | 0..0 |  |
code | S | 0..0 |  |
dataPeriod | S | 0..0 |  |
data | S | 0..0 |  |
provision | S | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Consent.scope | extensible | ConsentVS

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Indicates the current state of this restriction Binding: ConsentState (required): Indicates the state of the consent.
scope | ?!S Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S Σ | 1..* | CodeableConcept | Type of restriction Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
dateTime | S Σ | 0..1 | dateTime | date/time of last update for this restriction
policy | S | 0..* | BackboneElement | Policies covered by this consent
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uri | S C | 0..1 | uri | Specific policy covered by this restriction
policyRule | S Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision | S Σ | 0..1 | BackboneElement | Access rights
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S Σ | 0..1 | CodeableConcept | reasonType Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel | S Σ | 0..* | Coding | userType Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose | S Σ | 0..* | Coding | reasonName Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Consent.status | required | ConsentState
Consent.scope | extensible | ConsentVS
Consent.category | extensible | ConsentCategoryCodes
Consent.policyRule | extensible | ConsentPolicyRuleCodes
Consent.provision.type | required | Fixed Value: permit
Consent.provision.actor.role | extensible | SecurityRoleType
Consent.provision.action | example | ConsentActionCodes
Consent.provision.securityLabel | extensible | All Security Labels
Consent.provision.purpose | extensible | PurposeOfUse
Consent.provision.data.meaning | required | ConsentDataMeaning

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Indicates the current state of this restriction Binding: ConsentState (required): Indicates the state of the consent.
scope | ?!S Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S Σ | 1..* | CodeableConcept | Type of restriction Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
dateTime | S Σ | 0..1 | dateTime | date/time of last update for this restriction
policy | S | 0..* | BackboneElement | Policies covered by this consent
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uri | S C | 0..1 | uri | Specific policy covered by this restriction
policyRule | S Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision | S Σ | 0..1 | BackboneElement | Access rights
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S Σ | 0..1 | CodeableConcept | reasonType Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel | S Σ | 0..* | Coding | userType Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose | S Σ | 0..* | Coding | reasonName Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Consent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Consent.status | required | ConsentState
Consent.scope | extensible | ConsentVS
Consent.category | extensible | ConsentCategoryCodes
Consent.policyRule | extensible | ConsentPolicyRuleCodes
Consent.provision.type | required | Fixed Value: permit
Consent.provision.actor.role | extensible | SecurityRoleType
Consent.provision.action | example | ConsentActionCodes
Consent.provision.securityLabel | extensible | All Security Labels
Consent.provision.purpose | extensible | PurposeOfUse
Consent.provision.data.meaning | required | ConsentDataMeaning

This structure is derived from Consent

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 33 elements
Fixed Value: 1 element
Prohibited: 13 elements

Differential View

This structure is derived from Consent

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent |  | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
identifier | S | 0..0 |  |
status | S | 1..1 | code | Indicates the current state of this restriction
scope | S | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S | 1..* | CodeableConcept | Type of restriction
patient | S | 0..0 |  |
dateTime | S | 0..1 | dateTime | date/time of last update for this restriction
performer | S | 0..0 |  |
organization | S | 0..0 |  |
source[x] | S | 0..0 |  |
policy | S | 0..* | BackboneElement | Policies covered by this consent
authority | S | 0..0 |  |
uri | S | 0..1 | uri | Specific policy covered by this restriction
policyRule | S | 0..1 | CodeableConcept | Regulation that this consents to
verification | S | 0..0 |  |
provision | S | 0..1 | BackboneElement | Access rights
type | S | 0..1 | code | deny | permit Fixed Value: permit
period | S | 0..0 |  |
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
role | S | 1..1 | CodeableConcept | How the actor is involved
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S | 0..1 | CodeableConcept | reasonType
securityLabel | S | 0..* | Coding | userType
purpose | S | 0..* | Coding | reasonName
class | S | 0..0 |  |
code | S | 0..0 |  |
dataPeriod | S | 0..0 |  |
data | S | 0..0 |  |
provision | S | 0..0 |  |
Documentation for this format

#### Terminology Bindings (Differential)

Path | Conformance | ValueSet
Consent.scope | extensible | ConsentVS

Key Elements View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Indicates the current state of this restriction Binding: ConsentState (required): Indicates the state of the consent.
scope | ?!S Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S Σ | 1..* | CodeableConcept | Type of restriction Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
dateTime | S Σ | 0..1 | dateTime | date/time of last update for this restriction
policy | S | 0..* | BackboneElement | Policies covered by this consent
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uri | S C | 0..1 | uri | Specific policy covered by this restriction
policyRule | S Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision | S Σ | 0..1 | BackboneElement | Access rights
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S Σ | 0..1 | CodeableConcept | reasonType Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel | S Σ | 0..* | Coding | userType Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose | S Σ | 0..* | Coding | reasonName Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Consent.status | required | ConsentState
Consent.scope | extensible | ConsentVS
Consent.category | extensible | ConsentCategoryCodes
Consent.policyRule | extensible | ConsentPolicyRuleCodes
Consent.provision.type | required | Fixed Value: permit
Consent.provision.actor.role | extensible | SecurityRoleType
Consent.provision.action | example | ConsentActionCodes
Consent.provision.securityLabel | extensible | All Security Labels
Consent.provision.purpose | extensible | PurposeOfUse
Consent.provision.data.meaning | required | ConsentDataMeaning

Snapshot View

Name | Flags | Card. | Type | Description & Constraints
--- | --- | --- | --- | ---
Consent | C | 0..* | Consent | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
text |  | 0..1 | Narrative | Text summary of the resource, for human interpretation
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!S Σ | 1..1 | code | Indicates the current state of this restriction Binding: ConsentState (required): Indicates the state of the consent.
scope | ?!S Σ | 1..1 | CodeableConcept | Which of the four areas this resource covers (extensible) Binding: National Directory Consent Value Set (extensible)
category | S Σ | 1..* | CodeableConcept | Type of restriction Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.
dateTime | S Σ | 0..1 | dateTime | date/time of last update for this restriction
policy | S | 0..* | BackboneElement | Policies covered by this consent
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
uri | S C | 0..1 | uri | Specific policy covered by this restriction
policyRule | S Σ C | 0..1 | CodeableConcept | Regulation that this consents to Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.
provision | S Σ | 0..1 | BackboneElement | Access rights
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S Σ | 0..1 | code | deny | permit Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent. Fixed Value: permit
actor | S | 1..* | BackboneElement | Who|what controlled by this rule (or group, by role)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
role | S | 1..1 | CodeableConcept | How the actor is involved Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.
reference | S | 1..1 | Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole) | definedUserOrGroup
action | S Σ | 0..1 | CodeableConcept | reasonType Binding: ConsentActionCodes (example): Detailed codes for the consent action.
securityLabel | S Σ | 0..* | Coding | userType Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
purpose | S Σ | 0..* | Coding | reasonName Binding: PurposeOfUse (extensible): What purposes of use are controlled by this exception. If more than one label is specified, operations must have all the specified labels.
Documentation for this format

#### Terminology Bindings

Path | Conformance | ValueSet / Code
Consent.language | preferred | CommonLanguages
Additional Bindings | Purpose
AllLanguages | Max Binding
Consent.status | required | ConsentState
Consent.scope | extensible | ConsentVS
Consent.category | extensible | ConsentCategoryCodes
Consent.policyRule | extensible | ConsentPolicyRuleCodes
Consent.provision.type | required | Fixed Value: permit
Consent.provision.actor.role | extensible | SecurityRoleType
Consent.provision.action | example | ConsentActionCodes
Consent.provision.securityLabel | extensible | All Security Labels
Consent.provision.purpose | extensible | PurposeOfUse
Consent.provision.data.meaning | required | ConsentDataMeaning

This structure is derived from Consent

Summary

Mandatory: 0 element (1 nested mandatory element)
Must-Support: 33 elements
Fixed Value: 1 element
Prohibited: 13 elements

Other representations of profile: CSV, Excel, Schematron