National Healthcare Directory Exchange
1.0.0-ballot - ballot
National Healthcare Directory Exchange
1.0.0-ballot - ballot
National Healthcare Directory Exchange, published by HL7 Patient Administration Working 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-exchange/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/us/directory-exchange/StructureDefinition/NatlDirEx-Restriction | Version: 1.0.0-ballot | |||
| Active as of 2022-12-08 | Computable Name: NatlDirExRestriction | |||
Restriction describes details about a…
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from NatlDirRestriction
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Consent | 0..* | NatlDirRestriction | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | NatlDirRestriction | 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 | SC | 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 | ||||
| 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..* | NatlDirRestriction | 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.
| |||||
| 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 | SC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| 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 NatlDirRestriction
Differential View
This structure is derived from NatlDirRestriction
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | 0..* | NatlDirRestriction | A policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time | |
| Documentation for this format | ||||
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Consent | C | 0..* | NatlDirRestriction | 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 | SC | 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 | ||||
| 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..* | NatlDirRestriction | 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.
| |||||
| 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 | SC | 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 | ||||||||
| Path | Conformance | ValueSet / Code | ||||
| Consent.language | preferred | CommonLanguages
| ||||
| 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 NatlDirRestriction
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ HL7 Patient Administration Working Group. Package hl7.fhir.us.directory-exchange#1.0.0-ballot based on FHIR 4.0.1. Generated 2022-12-08
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change