National Healthcare Directory Exchange
1.0.0-ballot - ballot US

This page is part of the National Healthcare Directory Exchange (v1.0.0-ballot: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, 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-08-09 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

Summary

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 I0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical 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 SI0..1uriSpecific policy covered by this restriction
... policyRule SΣI0..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
NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... status ?!Σ1..1codeIndicates the current state of this restriction
Binding: ConsentState (required): Indicates the state of the consent.

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


... policy 0..*BackboneElementPolicies covered by this consent
.... uri I0..1uriSpecific policy covered by this restriction
... policyRule ΣI0..1CodeableConceptRegulation that this consents to
Binding: ConsentPolicyRuleCodes (extensible): Regulatory policy examples.

... provision Σ0..1BackboneElementAccess rights
.... type Σ0..1codedeny | permit
Binding: ConsentProvisionType (required): How a rule statement is applied, such as adding additional consent or removing consent.


Fixed Value: permit
.... actor 1..*BackboneElementWho|what controlled by this rule (or group, by role)
..... role 1..1CodeableConceptHow the actor is involved
Binding: SecurityRoleType (extensible): How an actor is involved in the consent considerations.

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


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


.... purpose Σ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

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Consent I0..*NatlDirRestrictionA policy may permit or deny recipients or roles to perform actions for specific purposes and periods of time
... id Σ0..1stringLogical 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 SI0..1uriSpecific policy covered by this restriction
... policyRule SΣI0..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

 

Other representations of profile: CSV, Excel, Schematron

Terminology Bindings

PathConformanceValueSet / Code
Consent.languagepreferredCommonLanguages
Max Binding: AllLanguages
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