R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). 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.8.2 StructureDefinition: ConsentDirective

(No assigned work group) Maturity Level: 1Informative Use 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.8.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: 3 elements (+7 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ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)
.... coding 0..*Coding
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 57016-8
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... term 0..*BackboneElementConsent Directive Term List
.... 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)
.... offer 1..1BackboneElement
..... topic 0..1Reference(Resource)Topic of this Consent Directive Term
..... text 0..1stringHuman readable Consent Directive term text
.... asset 0..*BackboneElement
..... valuedItem 0..0
.... agent 0..*BackboneElementConsent Directive Term Actor List
..... actor 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)
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... 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..1SignatureConsent Directive Documentation Signature
... 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..1BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules
... legallyBinding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract I0..*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: Common Languages (extensible)
... 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
... status ?!Σ0..1codeamended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: Contract Resource Status Codes (required)
... contentDerivative 0..1CodeableConceptContent derived from the basal information
Binding: Contract Content Derivation Codes (example)
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ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)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 57016-8
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... term I0..*BackboneElementConsent Directive Term List
.... id 0..1stringxml: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)
.... offer I1..1BackboneElementContext of the Contract term
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... topic Σ0..1Reference(Resource)Topic of this Consent Directive Term
..... type 0..1CodeableConceptContract Offer Type or Form
Binding: Contract Term Type Codes (example)
..... decision 0..1CodeableConceptDecision by Grantor
Binding: ActConsentDirective (extensible)
..... text 0..1stringHuman readable Consent Directive term text
..... linkId 0..1stringPointer to text
.... asset I0..*BackboneElementContract Term Asset List
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... class 0..1CodingResource Type, Profile, or CDA etc.
Binding: Consent Content Class (extensible)
..... code 0..1CodingCode in the content
Binding: Consent Content Codes (example)
..... period 0..1PeriodTime period of the asset
..... dataPeriod 0..1PeriodTime period of the data for the asset
..... data I0..*BackboneElementData defined by this Asset
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... meaning 0..1codeinstance | related | dependents | authoredby
Binding: ContractDataMeaning (required)
...... reference 0..1Reference(Resource)The actual data reference
..... securityLabel Σ0..*CodingSecurity Labels that define affected terms
Binding: All Security Labels (extensible)
.... agent I0..*BackboneElementConsent Directive Term Actor List
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... actor 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)
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... group 0..*Unknown reference to #Contract.term
Nested Consent DirectiveTerm Group
... signer I0..*BackboneElementConsent Directive Signer
.... id 0..1stringxml: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..1SignatureConsent Directive Documentation Signature
... friendly I0..*BackboneElementConsent Directive Friendly Language
.... id 0..1stringxml: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 I0..*BackboneElementConsent Directive Legal Language
.... id 0..1stringxml: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 I0..1BackboneElementComputable Consent Directive Language
.... id 0..1stringxml: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
... legallyBinding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive

doco Documentation for this format
<!-- ConsentDirective -->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>
 <status value="[code]"/><!-- 0..1 amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated   -->
 <contentDerivative><!-- 0..1 CodeableConcept Content derived from the basal information   --></contentDerivative>
 <issued value="[dateTime]"/><!-- 0..1 When this Consent Directive was issued -->
 <applies><!-- 0..1 Period Effective time --></applies>
 <subject><!-- 1..1 Reference(Patient) 
     The Patient is the topic of this 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> 1..1 CodeableConcept  <!-- 1..1 Consent Directive Type -->
  <coding> 0..* Coding  <!-- 0..* Code defined by a terminology system -->
   <system value="[uri]"/><!-- 0..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 0..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </type>
 <subType><!-- 0..* CodeableConcept Consent Directive Subtype   --></subType>
 <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>
  <offer> ?? 1..1 BackboneElement  <!-- ?? 1..1 Context of the Contract term -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <topic><!-- 0..1 Reference(Resource) 
       Topic of this Consent Directive Term --></topic>
   <type><!-- 0..1 CodeableConcept Contract Offer Type or Form   --></type>
   <decision><!-- 0..1 CodeableConcept Decision by Grantor   --></decision>
   <text value="[string]"/><!-- 0..1 Human readable Consent Directive term text -->
   <linkId value="[string]"/><!-- 0..1 Pointer to text -->
  </offer>
  <asset> ?? 0..* BackboneElement  <!-- ?? 0..* Contract Term Asset List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <class><!-- 0..1 Coding Resource Type, Profile, or CDA etc.   --></class>
   <code><!-- 0..1 Coding Code in the content   --></code>
   <period><!-- 0..1 Period Time period of the asset --></period>
   <dataPeriod><!-- 0..1 Period 
       Time period of the data for the asset --></dataPeriod>
   <data> ?? 0..* BackboneElement  <!-- ?? 0..* Data defined by this Asset -->
    <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
    <meaning value="[code]"/><!-- 0..1 instance | related | dependents | authoredby   -->
    <reference><!-- 0..1 Reference(Resource) 
        The actual data reference --></reference>
   </data>
   <valuedItem> ?? 0..0 BackboneElement  <!-- ?? 0..0 Contract Term Valued Item -->
   </valuedItem>
   <securityLabel><!-- 0..* Coding Security Labels that define affected terms   --></securityLabel>
  </asset>
  <agent> ?? 0..* BackboneElement  <!-- ?? 0..* Consent Directive  Term Actor List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <actor><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
     Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
       Consent Directive Term Actor --></actor>
   <role><!-- 0..* CodeableConcept Consent Directive Term Actor Role   --></role>
  </agent>
  <action><!-- 0..* CodeableConcept Consent Directive Term Action   --></action>
  <actionReason><!-- 0..* CodeableConcept Consent Directive Term Action Reason   --></actionReason>
  <group><!-- See #Contract.term  Nested Consent DirectiveTerm Group --></group>
 </term>
 <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><!-- 1..1 Signature 
      Consent Directive Documentation Signature --></signature>
 </signer>
 <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..1 BackboneElement  <!-- ?? 0..1 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>
 <legallyBinding[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
     Binding Consent Directive --></legallyBinding[x]>
</Contract>

{ // ConsentDirective
  // 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
    "status" : "<code>", //amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
    "contentDerivative" : { CodeableConcept }, //Content derived from the basal information
    "issued" : "<dateTime>", //When this Consent Directive was issued
    "applies" : { Period }, //Effective time
    "subject" : { Reference(Patient) }, // R! The Patient is the topic of this 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 }, // R! Consent Directive Type
    "subType" : [{ CodeableConcept }], //Consent Directive Subtype
    "term" : [{ BackboneElement }], // C?Consent Directive Term List
    "signer" : [{ BackboneElement }], // C?Consent Directive Signer
    "friendly" : [{ BackboneElement }], // C?Consent Directive Friendly Language
    "legal" : [{ BackboneElement }], // C?Consent Directive Legal Language
    "rule" : { BackboneElement }, // C?Computable Consent Directive Language
// value[x]: Binding Consent Directive. One of these 4:
    "legallyBindingAttachment" : { Attachment } // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(Composition) }, // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(DocumentReference) }, // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(QuestionnaireResponse) }, // R! Binding Consent Directive
  }

This structure is derived from Contract.

Summary

Mandatory: 3 elements (+7 nested mandatory elements)
Fixed Value: 2 elements
Prohibited: 1 element

Differential View

This structure is derived from Contract.

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*Consent Directive
... identifier Σ0..1IdentifierConsent Directive identifier
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ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)
.... coding 0..*Coding
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 57016-8
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... term 0..*BackboneElementConsent Directive Term List
.... 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)
.... offer 1..1BackboneElement
..... topic 0..1Reference(Resource)Topic of this Consent Directive Term
..... text 0..1stringHuman readable Consent Directive term text
.... asset 0..*BackboneElement
..... valuedItem 0..0
.... agent 0..*BackboneElementConsent Directive Term Actor List
..... actor 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)
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... group 0..*Unknown reference to #term
Nested Consent DirectiveTerm Group
... 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..1SignatureConsent Directive Documentation Signature
... 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..1BackboneElementComputable Consent Directive Language
.... content[x] 1..1Attachment, Reference(DocumentReference)Computable Consent Directive Rules
... legallyBinding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract I0..*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: Common Languages (extensible)
... 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
... status ?!Σ0..1codeamended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
Binding: Contract Resource Status Codes (required)
... contentDerivative 0..1CodeableConceptContent derived from the basal information
Binding: Contract Content Derivation Codes (example)
... issued Σ0..1dateTimeWhen this Consent Directive was issued
... applies Σ0..1PeriodEffective time
... subject Σ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)
.... id 0..1stringxml:id (or equivalent in JSON)
.... coding Σ0..*CodingCode defined by a terminology system
..... id 0..1stringxml:id (or equivalent in JSON)
..... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://loinc.org
..... version Σ0..1stringVersion of the system - if relevant
..... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: 57016-8
..... display Σ0..1stringRepresentation defined by the system
..... userSelected Σ0..1booleanIf this coding was chosen directly by the user
.... text Σ0..1stringPlain text representation of the concept
... subType Σ0..*CodeableConceptConsent Directive Subtype
Binding: Contract Subtype Codes (example)
... term I0..*BackboneElementConsent Directive Term List
.... id 0..1stringxml: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)
.... offer I1..1BackboneElementContext of the Contract term
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... topic Σ0..1Reference(Resource)Topic of this Consent Directive Term
..... type 0..1CodeableConceptContract Offer Type or Form
Binding: Contract Term Type Codes (example)
..... decision 0..1CodeableConceptDecision by Grantor
Binding: ActConsentDirective (extensible)
..... text 0..1stringHuman readable Consent Directive term text
..... linkId 0..1stringPointer to text
.... asset I0..*BackboneElementContract Term Asset List
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... class 0..1CodingResource Type, Profile, or CDA etc.
Binding: Consent Content Class (extensible)
..... code 0..1CodingCode in the content
Binding: Consent Content Codes (example)
..... period 0..1PeriodTime period of the asset
..... dataPeriod 0..1PeriodTime period of the data for the asset
..... data I0..*BackboneElementData defined by this Asset
...... id 0..1stringxml:id (or equivalent in JSON)
...... extension 0..*ExtensionAdditional content defined by implementations
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
...... meaning 0..1codeinstance | related | dependents | authoredby
Binding: ContractDataMeaning (required)
...... reference 0..1Reference(Resource)The actual data reference
..... securityLabel Σ0..*CodingSecurity Labels that define affected terms
Binding: All Security Labels (extensible)
.... agent I0..*BackboneElementConsent Directive Term Actor List
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional content defined by implementations
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
..... actor 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)
.... action 0..*CodeableConceptConsent Directive Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptConsent Directive Term Action Reason
Binding: PurposeOfUse (example)
.... group 0..*Unknown reference to #Contract.term
Nested Consent DirectiveTerm Group
... signer I0..*BackboneElementConsent Directive Signer
.... id 0..1stringxml: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..1SignatureConsent Directive Documentation Signature
... friendly I0..*BackboneElementConsent Directive Friendly Language
.... id 0..1stringxml: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 I0..*BackboneElementConsent Directive Legal Language
.... id 0..1stringxml: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 I0..1BackboneElementComputable Consent Directive Language
.... id 0..1stringxml: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
... legallyBinding[x] 1..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Consent Directive

doco Documentation for this format

XML Template

<!-- ConsentDirective -->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>
 <status value="[code]"/><!-- 0..1 amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated   -->
 <contentDerivative><!-- 0..1 CodeableConcept Content derived from the basal information   --></contentDerivative>
 <issued value="[dateTime]"/><!-- 0..1 When this Consent Directive was issued -->
 <applies><!-- 0..1 Period Effective time --></applies>
 <subject><!-- 1..1 Reference(Patient) 
     The Patient is the topic of this 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> 1..1 CodeableConcept  <!-- 1..1 Consent Directive Type -->
  <coding> 0..* Coding  <!-- 0..* Code defined by a terminology system -->
   <system value="[uri]"/><!-- 0..1 Identity of the terminology system -->
   <version value="[string]"/><!-- 0..1 Version of the system - if relevant -->
   <code value="[code]"/><!-- 0..1 Symbol in syntax defined by the system -->
   <display value="[string]"/><!-- 0..1 Representation defined by the system -->
   <userSelected value="[boolean]"/><!-- 0..1 If this coding was chosen directly by the user -->
  </coding>
  <text value="[string]"/><!-- 0..1 Plain text representation of the concept -->
 </type>
 <subType><!-- 0..* CodeableConcept Consent Directive Subtype   --></subType>
 <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>
  <offer> ?? 1..1 BackboneElement  <!-- ?? 1..1 Context of the Contract term -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <topic><!-- 0..1 Reference(Resource) 
       Topic of this Consent Directive Term --></topic>
   <type><!-- 0..1 CodeableConcept Contract Offer Type or Form   --></type>
   <decision><!-- 0..1 CodeableConcept Decision by Grantor   --></decision>
   <text value="[string]"/><!-- 0..1 Human readable Consent Directive term text -->
   <linkId value="[string]"/><!-- 0..1 Pointer to text -->
  </offer>
  <asset> ?? 0..* BackboneElement  <!-- ?? 0..* Contract Term Asset List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <class><!-- 0..1 Coding Resource Type, Profile, or CDA etc.   --></class>
   <code><!-- 0..1 Coding Code in the content   --></code>
   <period><!-- 0..1 Period Time period of the asset --></period>
   <dataPeriod><!-- 0..1 Period 
       Time period of the data for the asset --></dataPeriod>
   <data> ?? 0..* BackboneElement  <!-- ?? 0..* Data defined by this Asset -->
    <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
    <meaning value="[code]"/><!-- 0..1 instance | related | dependents | authoredby   -->
    <reference><!-- 0..1 Reference(Resource) 
        The actual data reference --></reference>
   </data>
   <valuedItem> ?? 0..0 BackboneElement  <!-- ?? 0..0 Contract Term Valued Item -->
   </valuedItem>
   <securityLabel><!-- 0..* Coding Security Labels that define affected terms   --></securityLabel>
  </asset>
  <agent> ?? 0..* BackboneElement  <!-- ?? 0..* Consent Directive  Term Actor List -->
   <modifierExtension><!-- 0..* Extension  Extensions that cannot be ignored  --></modifierExtension>
   <actor><!-- 1..1 Reference(Contract)|Reference(Device)|Reference(Group)|Reference(Location)|
     Reference(Organization)|Reference(Patient)|Reference(Practitioner)|Reference(RelatedPerson)|Reference(Substance) 
       Consent Directive Term Actor --></actor>
   <role><!-- 0..* CodeableConcept Consent Directive Term Actor Role   --></role>
  </agent>
  <action><!-- 0..* CodeableConcept Consent Directive Term Action   --></action>
  <actionReason><!-- 0..* CodeableConcept Consent Directive Term Action Reason   --></actionReason>
  <group><!-- See #Contract.term  Nested Consent DirectiveTerm Group --></group>
 </term>
 <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><!-- 1..1 Signature 
      Consent Directive Documentation Signature --></signature>
 </signer>
 <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..1 BackboneElement  <!-- ?? 0..1 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>
 <legallyBinding[x]><!-- 1..1 Attachment|Reference(Composition)|Reference(DocumentReference)|Reference(QuestionnaireResponse) 
     Binding Consent Directive --></legallyBinding[x]>
</Contract>

JSON Template

{ // ConsentDirective
  // 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
    "status" : "<code>", //amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated
    "contentDerivative" : { CodeableConcept }, //Content derived from the basal information
    "issued" : "<dateTime>", //When this Consent Directive was issued
    "applies" : { Period }, //Effective time
    "subject" : { Reference(Patient) }, // R! The Patient is the topic of this 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 }, // R! Consent Directive Type
    "subType" : [{ CodeableConcept }], //Consent Directive Subtype
    "term" : [{ BackboneElement }], // C?Consent Directive Term List
    "signer" : [{ BackboneElement }], // C?Consent Directive Signer
    "friendly" : [{ BackboneElement }], // C?Consent Directive Friendly Language
    "legal" : [{ BackboneElement }], // C?Consent Directive Legal Language
    "rule" : { BackboneElement }, // C?Computable Consent Directive Language
// value[x]: Binding Consent Directive. One of these 4:
    "legallyBindingAttachment" : { Attachment } // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(Composition) }, // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(DocumentReference) }, // R! Binding Consent Directive
    "legallyBindingReference" : { Reference(QuestionnaireResponse) }, // R! Binding Consent Directive
  }

 

Alternate definitions: Master Definition (XML, JSON), Schematron

13.11.8.2.2 Terminology Bindings

PathNameConformanceValueSet
Contract.languageCommon LanguagesextensibleCommon Languages
Contract.statusContract Resource Status CodesrequiredContract Resource Status Codes
Contract.contentDerivativeContract Content Derivation CodesexampleContract Content Derivation Codes
Contract.typeContract Type CodesexampleContract Type Codes
Contract.subTypeContract Subtype CodesexampleContract Subtype Codes
Contract.term.typeContract Term Type CodesexampleContract Term Type Codes
Contract.term.subTypeContract Term Subtype CodesexampleContract Term Subtype Codes
Contract.term.offer.typeContract Term Type CodesexampleContract Term Type Codes
Contract.term.offer.decisionActConsentDirectiveextensibleActConsentDirective
Contract.term.asset.classConsent Content ClassextensibleConsent Content Class
Contract.term.asset.codeConsent Content CodesexampleConsent Content Codes
Contract.term.asset.data.meaningContractDataMeaningrequiredContractDataMeaning
Contract.term.asset.securityLabelAll Security LabelsextensibleAll Security Labels
Contract.term.agent.roleContract Actor Role CodesexampleContract Actor Role Codes
Contract.term.actionContract Action CodesexampleContract Action Codes
Contract.term.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.signer.typeContract Signer Type CodespreferredContract Signer Type Codes
.