National Healthcare Directory Exchange
1.0.0-ballot - ballot United States of America flag

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

Resource Profile: National Directory Restriction

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:

Formal Views of Profile Content

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

This structure is derived from NatlDirRestriction

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeIndicates the current state of this restriction
Binding: ConsentState (required): Indicates the state of the consent.

... category SΣ1..*CodeableConceptType of restriction
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


... dateTime SΣ0..1dateTimedate/time of last update for this restriction
... policy S0..*BackboneElementPolicies covered by this consent
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri SC0..1uriSpecific policy covered by this restriction
... policyRule SΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ0..1BackboneElementAccess rights
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference S1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)definedUserOrGroup
.... action SΣ0..1CodeableConceptreasonType
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel SΣ0..*CodinguserType
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose SΣ0..*CodingreasonName
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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentVS
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.data.meaningrequiredConsentDataMeaning
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeIndicates the current state of this restriction
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: National Directory Consent Value Set (extensible)
... category SΣ1..*CodeableConceptType of restriction
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


... dateTime SΣ0..1dateTimedate/time of last update for this restriction
... policy S0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri SC0..1uriSpecific policy covered by this restriction
... policyRule SΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ0..1BackboneElementAccess rights
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference S1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)definedUserOrGroup
.... action SΣ0..1CodeableConceptreasonType
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel SΣ0..*CodinguserType
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose SΣ0..*CodingreasonName
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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentVS
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.data.meaningrequiredConsentDataMeaning

This structure is derived from NatlDirRestriction

Summary

Differential View

This structure is derived from NatlDirRestriction

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent 0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeIndicates the current state of this restriction
Binding: ConsentState (required): Indicates the state of the consent.

... category SΣ1..*CodeableConceptType of restriction
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


... dateTime SΣ0..1dateTimedate/time of last update for this restriction
... policy S0..*BackboneElementPolicies covered by this consent
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri SC0..1uriSpecific policy covered by this restriction
... policyRule SΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ0..1BackboneElementAccess rights
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference S1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)definedUserOrGroup
.... action SΣ0..1CodeableConceptreasonType
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel SΣ0..*CodinguserType
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose SΣ0..*CodingreasonName
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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentVS
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.data.meaningrequiredConsentDataMeaning

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent C0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... status ?!SΣ1..1codeIndicates the current state of this restriction
Binding: ConsentState (required): Indicates the state of the consent.

... scope ?!SΣ1..1CodeableConceptWhich of the four areas this resource covers (extensible)
Binding: National Directory Consent Value Set (extensible)
... category SΣ1..*CodeableConceptType of restriction
Binding: ConsentCategoryCodes (extensible): A classification of the type of consents found in a consent statement.


... dateTime SΣ0..1dateTimedate/time of last update for this restriction
... policy S0..*BackboneElementPolicies covered by this consent
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... uri SC0..1uriSpecific policy covered by this restriction
... policyRule SΣC0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision SΣ0..1BackboneElementAccess rights
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type SΣ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... actor S1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... role S1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

..... reference S1..1Reference(Device | Group | CareTeam | Organization | Patient | Practitioner | RelatedPerson | PractitionerRole)definedUserOrGroup
.... action SΣ0..1CodeableConceptreasonType
Binding: ConsentActionCodes (example): Detailed codes for the consent action.


.... securityLabel SΣ0..*CodinguserType
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... purpose SΣ0..*CodingreasonName
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.



doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
Consent.statusrequiredConsentState
Consent.scopeextensibleConsentVS
Consent.categoryextensibleConsentCategoryCodes
Consent.policyRuleextensibleConsentPolicyRuleCodes
Consent.provision.typerequiredFixed Value: permit
Consent.provision.actor.roleextensibleSecurityRoleType
Consent.provision.actionexampleConsentActionCodes
Consent.provision.securityLabelextensibleAll Security Labels
Consent.provision.purposeextensiblePurposeOfUse
Consent.provision.data.meaningrequiredConsentDataMeaning

This structure is derived from NatlDirRestriction

Summary

 

Other representations of profile: CSV, Excel, Schematron