FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R3 R2

13.11.9.2 StructureDefinition: Consent Directive

(No assigned work group) Maturity Level: 1InformativeUse Context: Any

The official URL for this profile is: 

http://hl7.org/fhir/StructureDefinition/consentdirective

Consent Directive

This profile was published on Fri, Jan 31, 2014 00:00+1100 as a draft by .

13.11.9.2.1 Formal Views of Profile Content

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

This structure is derived from Contract.

Summary

Mandatory: 0 element (+11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... actor 0..*BackboneElementConsent Directive Actor
.... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... topic Σ1..1Reference(Patient)The Patient is the topic of this Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type Σ1..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... signer 0..*BackboneElementConsent Directive Signer
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... valuedItem 0..0
... term 0..*BackboneElementConsent Directive Term List
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... identifier Σ0..1IdentifierConsent Directive Term identifier
.... issued Σ0..1dateTimeConsent Directive Term Issue Date Time
.... applies Σ0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Subtype Codes (example)
.... topic 0..*Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... text 0..1stringHuman readable Consent Directive term text
.... valuedItem 0..0
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... 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
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..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
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ0..*Reference(Resource)Patient who is the subject of this Privacy Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type Σ0..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... signer 0..*BackboneElementConsent Directive Signer
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..1IdentifierConsent Directive Term identifier
.... issued Σ0..1dateTimeConsent Directive Term Issue Date Time
.... applies Σ0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Subtype Codes (example)
.... topic 0..1Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... group 0..*Unknown reference to #Contract.term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format
<!-- Consent Directive -->doco

<Contract xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content  -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..1 Identifier Consent Directive identifier --></identifier>
 <issued value="[dateTime]"/><!-- 0..1 When this Consent Directive was issued -->
 <applies><!-- 0..1 Period Effective time --></applies>
 <subject><!-- 0..* Reference(Resource) 
     Patient who is the subject of this Privacy Consent Directive --></subject>
 <authority><!-- 0..* Reference(Organization) 
     Authority under which this Consent Directive has standing --></authority>
 <domain><!-- 0..* Reference(Location) 
     Domain in which this Consent Directive applies --></domain>
 <type><!-- 0..1 CodeableConcept Consent Directive Type  --></type>
 <subType><!-- 0..* CodeableConcept Consent Directive Subtype  --></subType>
 <action><!-- 0..* CodeableConcept Consent Directive Action  --></action>
 <actionReason><!-- 0..* CodeableConcept Consent Directive Action Reason  --></actionReason>
 <actor> 0..* BackboneElement  <!-- 0..* Consent Directive Actor -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <entity><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
    Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
      Consent Directive Actor Type --></entity>
  <role><!-- 0..* CodeableConcept Consent Directive Actor Role  --></role>
 </actor>
 <valuedItem> 0..0 BackboneElement  <!-- 0..0 Contract Valued Item -->
 </valuedItem>
 <signer> 0..* BackboneElement  <!-- 0..* Consent Directive Signer -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <type><!-- 1..1 Coding Consent Directive Signer Type  --></type>
  <party><!-- 1..1 Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson) 
      Consent Directive Signatory party --></party>
  <signature value="[string]"/><!-- 1..1 Consent Directive Documentation Signature -->
 </signer>
 <term> 0..* BackboneElement  <!-- 0..* Consent Directive Term List -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <identifier><!-- 0..1 Identifier 
      Consent Directive Term identifier --></identifier>
  <issued value="[dateTime]"/><!-- 0..1 Consent Directive Term Issue Date Time -->
  <applies><!-- 0..1 Period 
      Consent Directive Term Effective Time --></applies>
  <type><!-- 0..1 CodeableConcept Consent Directive Term Type  --></type>
  <subType><!-- 0..1 CodeableConcept Consent Directive Term Subtype  --></subType>
  <topic><!-- 0..1 Reference(Resource) Topic of this Consent Directive Term --></topic>
  <action><!-- 0..* CodeableConcept Consent Directive Term Action  --></action>
  <actionReason><!-- 0..* CodeableConcept Consent Directive Term Action Reason  --></actionReason>
  <actor> 0..* BackboneElement  <!-- 0..* Consent Directive  Term Actor List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <entity><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
     Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
       Consent Directive Term Actor --></entity>
   <role><!-- 0..* CodeableConcept Consent Directive Term Actor Role  --></role>
  </actor>
  <text value="[string]"/><!-- 0..1 Human readable Consent Directive term text -->
  <valuedItem> 0..0 BackboneElement  <!-- 0..0 Contract Term Valued Item -->
  </valuedItem>
  <group><!-- See #Contract.term  Nested Consent DirectiveTerm Group --></group>
 </term>
 <binding[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
     Binding Consent Directive --></binding[x]>
 <friendly> 0..* BackboneElement  <!-- 0..* Consent Directive Friendly Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|
    Reference(QuestionnaireResponse) 
      Easily comprehended representation of this Consent Directive --></content[x]>
 </friendly>
 <legal> 0..* BackboneElement  <!-- 0..* Consent Directive Legal Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
      Consent Directive Legal Text --></content[x]>
 </legal>
 <rule> 0..* BackboneElement  <!-- 0..* Computable Consent Directive Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(DocumentReference) 
      Computable Consent Directive Rules --></content[x]>
 </rule>
</Contract>

{ // Consent Directive
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content 
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : { Identifier }, //Consent Directive identifier
    "issued" : "<dateTime>", //When this Consent Directive was issued
    "applies" : { Period }, //Effective time
    "subject" : [{ Reference(Resource) }], //Patient who is the subject of this Privacy Consent Directive
    "authority" : [{ Reference(Organization) }], //Authority under which this Consent Directive has standing
    "domain" : [{ Reference(Location) }], //Domain in which this Consent Directive applies
    "type" : { CodeableConcept }, //Consent Directive Type 
    "subType" : [{ CodeableConcept }], //Consent Directive Subtype 
    "action" : [{ CodeableConcept }], //Consent Directive Action 
    "actionReason" : [{ CodeableConcept }], //Consent Directive Action Reason 
    "actor" : [{ BackboneElement }], //Consent Directive Actor
    "signer" : [{ BackboneElement }], //Consent Directive Signer
    "term" : [{ BackboneElement }], //Consent Directive Term List
// value[x]: Binding Consent Directive. One of these 4:
    "bindingAttachment" : { Attachment }, // R! Binding Consent Directive
    "bindingReference" : { Reference(Composition) }, // R! Binding Consent Directive
    "bindingReference" : { Reference(DocumentReference) }, // R! Binding Consent Directive
    "bindingReference" : { Reference(QuestionnaireResponse) } // R! Binding Consent Directive
    "friendly" : [{ BackboneElement }], //Consent Directive Friendly Language
    "legal" : [{ BackboneElement }], //Consent Directive Legal Language
    "rule" : [{ BackboneElement }], //Computable Consent Directive Language
  }

This structure is derived from Contract.

Summary

Mandatory: 0 element (+11 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 2 elements

Differential View

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... actor 0..*BackboneElementConsent Directive Actor
.... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... topic Σ1..1Reference(Patient)The Patient is the topic of this Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type Σ1..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... signer 0..*BackboneElementConsent Directive Signer
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... valuedItem 0..0
... term 0..*BackboneElementConsent Directive Term List
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... identifier Σ0..1IdentifierConsent Directive Term identifier
.... issued Σ0..1dateTimeConsent Directive Term Issue Date Time
.... applies Σ0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Subtype Codes (example)
.... topic 0..*Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... text 0..1stringHuman readable Consent Directive term text
.... valuedItem 0..0
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... 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
... language 0..1codeLanguage of the resource content
Binding: IETF BCP-47 (required)
... text I0..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
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ0..*Reference(Resource)Patient who is the subject of this Privacy Consent Directive
... authority 0..*Reference(Organization)Authority under which this Consent Directive has standing
... domain 0..*Reference(Location)Domain in which this Consent Directive applies
... type Σ0..1CodeableConceptConsent Directive Type
Binding: Contract Type Codes (example)
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptConsent Directive Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptConsent Directive Action Reason
Binding: PurposeOfUse (example)
... actor 0..*BackboneElementConsent Directive Actor
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Actor Type
.... role 0..*CodeableConceptConsent Directive Actor Role
Binding: Contract Actor Role Codes (example)
... signer 0..*BackboneElementConsent Directive Signer
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... type 1..1CodingConsent Directive Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Consent Directive Signatory party
.... signature 1..1stringConsent Directive Documentation Signature
... term 0..*BackboneElementConsent Directive Term List
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... identifier Σ0..1IdentifierConsent Directive Term identifier
.... issued Σ0..1dateTimeConsent Directive Term Issue Date Time
.... applies Σ0..1PeriodConsent Directive Term Effective Time
.... type 0..1CodeableConceptConsent Directive Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptConsent Directive Term Subtype
Binding: Contract Term Subtype Codes (example)
.... topic 0..1Reference(Resource)Topic of this Consent Directive Term
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... actor 0..*BackboneElementConsent Directive Term Actor List
..... id 0..1idxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
..... entity 1..1Reference(Contract), Reference(Device), Reference(Group), Reference(Location), Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson), Reference(Substance)Consent Directive Term Actor
..... role 0..*CodeableConceptConsent Directive Term Actor Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Consent Directive term text
.... group 0..*Unknown reference to #Contract.term
Nested Consent DirectiveTerm Group
... binding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive
... friendly 0..*BackboneElementConsent Directive Friendly Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Easily comprehended representation of this Consent Directive
... legal 0..*BackboneElementConsent Directive Legal Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Consent Directive Legal Text
... rule 0..*BackboneElementComputable Consent Directive Language
.... id 0..1idxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules

doco Documentation for this format

XML Template

<!-- Consent Directive -->doco

<Contract xmlns="http://hl7.org/fhir"
>
  <!-- from Element: extension -->
 <id value="[id]"/><!-- 0..1 Logical id of this artifact -->
 <meta><!-- 0..1 Meta Metadata about the resource --></meta>
 <implicitRules value="[uri]"/><!-- 0..1 A set of rules under which this content was created -->
 <language value="[code]"/><!-- 0..1 Language of the resource content  -->
 <text><!-- 0..1 Narrative 
     Text summary of the resource, for human interpretation --></text>
 <contained><!-- 0..* Resource Contained, inline Resources --></contained>
 <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
 <identifier><!-- 0..1 Identifier Consent Directive identifier --></identifier>
 <issued value="[dateTime]"/><!-- 0..1 When this Consent Directive was issued -->
 <applies><!-- 0..1 Period Effective time --></applies>
 <subject><!-- 0..* Reference(Resource) 
     Patient who is the subject of this Privacy Consent Directive --></subject>
 <authority><!-- 0..* Reference(Organization) 
     Authority under which this Consent Directive has standing --></authority>
 <domain><!-- 0..* Reference(Location) 
     Domain in which this Consent Directive applies --></domain>
 <type><!-- 0..1 CodeableConcept Consent Directive Type  --></type>
 <subType><!-- 0..* CodeableConcept Consent Directive Subtype  --></subType>
 <action><!-- 0..* CodeableConcept Consent Directive Action  --></action>
 <actionReason><!-- 0..* CodeableConcept Consent Directive Action Reason  --></actionReason>
 <actor> 0..* BackboneElement  <!-- 0..* Consent Directive Actor -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <entity><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
    Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
      Consent Directive Actor Type --></entity>
  <role><!-- 0..* CodeableConcept Consent Directive Actor Role  --></role>
 </actor>
 <valuedItem> 0..0 BackboneElement  <!-- 0..0 Contract Valued Item -->
 </valuedItem>
 <signer> 0..* BackboneElement  <!-- 0..* Consent Directive Signer -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <type><!-- 1..1 Coding Consent Directive Signer Type  --></type>
  <party><!-- 1..1 Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson) 
      Consent Directive Signatory party --></party>
  <signature value="[string]"/><!-- 1..1 Consent Directive Documentation Signature -->
 </signer>
 <term> 0..* BackboneElement  <!-- 0..* Consent Directive Term List -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <identifier><!-- 0..1 Identifier 
      Consent Directive Term identifier --></identifier>
  <issued value="[dateTime]"/><!-- 0..1 Consent Directive Term Issue Date Time -->
  <applies><!-- 0..1 Period 
      Consent Directive Term Effective Time --></applies>
  <type><!-- 0..1 CodeableConcept Consent Directive Term Type  --></type>
  <subType><!-- 0..1 CodeableConcept Consent Directive Term Subtype  --></subType>
  <topic><!-- 0..1 Reference(Resource) Topic of this Consent Directive Term --></topic>
  <action><!-- 0..* CodeableConcept Consent Directive Term Action  --></action>
  <actionReason><!-- 0..* CodeableConcept Consent Directive Term Action Reason  --></actionReason>
  <actor> 0..* BackboneElement  <!-- 0..* Consent Directive  Term Actor List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <entity><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
     Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
       Consent Directive Term Actor --></entity>
   <role><!-- 0..* CodeableConcept Consent Directive Term Actor Role  --></role>
  </actor>
  <text value="[string]"/><!-- 0..1 Human readable Consent Directive term text -->
  <valuedItem> 0..0 BackboneElement  <!-- 0..0 Contract Term Valued Item -->
  </valuedItem>
  <group><!-- See #Contract.term  Nested Consent DirectiveTerm Group --></group>
 </term>
 <binding[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
     Binding Consent Directive --></binding[x]>
 <friendly> 0..* BackboneElement  <!-- 0..* Consent Directive Friendly Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|
    Reference(QuestionnaireResponse) 
      Easily comprehended representation of this Consent Directive --></content[x]>
 </friendly>
 <legal> 0..* BackboneElement  <!-- 0..* Consent Directive Legal Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
      Consent Directive Legal Text --></content[x]>
 </legal>
 <rule> 0..* BackboneElement  <!-- 0..* Computable Consent Directive Language -->
  <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
  <content[x]><!-- 1..1 Attachment|Reference(DocumentReference) 
      Computable Consent Directive Rules --></content[x]>
 </rule>
</Contract>

JSON Template

{ // Consent Directive
  // from Element: extension
    "meta" : { Meta }, //Metadata about the resource
    "implicitRules" : "<uri>", //A set of rules under which this content was created
    "language" : "<code>", //Language of the resource content 
    "text" : { Narrative }, //Text summary of the resource, for human interpretation
    "contained" : [{ Resource }], //Contained, inline Resources
    "modifierExtension" : [{ Extension }], //Extensions that cannot be ignored
    "identifier" : { Identifier }, //Consent Directive identifier
    "issued" : "<dateTime>", //When this Consent Directive was issued
    "applies" : { Period }, //Effective time
    "subject" : [{ Reference(Resource) }], //Patient who is the subject of this Privacy Consent Directive
    "authority" : [{ Reference(Organization) }], //Authority under which this Consent Directive has standing
    "domain" : [{ Reference(Location) }], //Domain in which this Consent Directive applies
    "type" : { CodeableConcept }, //Consent Directive Type 
    "subType" : [{ CodeableConcept }], //Consent Directive Subtype 
    "action" : [{ CodeableConcept }], //Consent Directive Action 
    "actionReason" : [{ CodeableConcept }], //Consent Directive Action Reason 
    "actor" : [{ BackboneElement }], //Consent Directive Actor
    "signer" : [{ BackboneElement }], //Consent Directive Signer
    "term" : [{ BackboneElement }], //Consent Directive Term List
// value[x]: Binding Consent Directive. One of these 4:
    "bindingAttachment" : { Attachment }, // R! Binding Consent Directive
    "bindingReference" : { Reference(Composition) }, // R! Binding Consent Directive
    "bindingReference" : { Reference(DocumentReference) }, // R! Binding Consent Directive
    "bindingReference" : { Reference(QuestionnaireResponse) } // R! Binding Consent Directive
    "friendly" : [{ BackboneElement }], //Consent Directive Friendly Language
    "legal" : [{ BackboneElement }], //Consent Directive Legal Language
    "rule" : [{ BackboneElement }], //Computable Consent Directive Language
  }

 

Other representations of profile: Schematron

13.11.9.2.2 Terminology Bindings

PathNameConformanceValueSet
Contract.language?extrequiredhttp://tools.ietf.org/html/bcp47
Contract.typeContract Type CodesexampleContract Type Codes
Contract.subTypeContract Subtype CodesexampleContract Subtype Codes
Contract.actionContract Action CodesexampleContract Action Codes
Contract.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.actor.roleContract Actor Role CodesexampleContract Actor Role Codes
Contract.signer.typeContract Signer Type CodespreferredContract Signer Type Codes
Contract.term.typeContract Term Type CodesexampleContract Term Type Codes
Contract.term.subTypeContract Term Subtype CodesexampleContract Term Subtype Codes
Contract.term.actionContract Action CodesexampleContract Action Codes
Contract.term.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.term.actor.roleContract Actor Role CodesexampleContract Actor Role Codes

13.11.9.2.3 Constraints

IdPathDetailsRequirements
qty-3Contract.valuedItem.quantityIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
sqty-1Contract.valuedItem.quantityThe comparator is not used on a SimpleQuantity
Expression : comparator.empty()
qty-3Contract.valuedItem.unitPriceIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
mny-1Contract.valuedItem.unitPriceThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
Expression : (code or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
qty-3Contract.valuedItem.netIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
mny-1Contract.valuedItem.netThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
Expression : (code or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
qty-3Contract.term.valuedItem.quantityIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
sqty-1Contract.term.valuedItem.quantityThe comparator is not used on a SimpleQuantity
Expression : comparator.empty()
qty-3Contract.term.valuedItem.unitPriceIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
mny-1Contract.term.valuedItem.unitPriceThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
Expression : (code or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
qty-3Contract.term.valuedItem.netIf a code for the unit is present, the system SHALL also be present
Expression : code.empty() or system
mny-1Contract.term.valuedItem.netThere SHALL be a code if there is a value and it SHALL be an expression of currency. If system is present, it SHALL be ISO 4217 (system = "urn:iso:std:iso:4217" - currency).
Expression : (code or value.empty()) and (system.empty() or system = 'urn:iso:std:iso:4217')
.