Current Build

This page is part of the C-CDA on FHIR Implementation Guide (v1.8.0: STU 1 Ballot 2) based on FHIR v1.8.0. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions

D.4.1 StructureDefinition: CCDA-on-FHIR-Consent

D.4.1.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org/fhir/ccda/StructureDefinition/CCDA-on-FHIR-Consent

This profile represents information about the patients consent.

The type of consent is conveyed in type. Consents in the header have been finalized and should be on file. This specification does not address how 'Privacy Consent' is represented, but does not preclude the inclusion of Privacy Consent.

The authorization consent is used for referring to consents that are documented elsewhere in the EHR or medical record for a health condition and/or treatment that is described in the document.

This profile builds on Contract.

This profile was published on Thu Dec 08 06:39:19 AEDT 2016 as a draft by Lantana Consulting Group.

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

This structure is derived from Contract

Summary

Mandatory: 1 element

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*
... identifier 0..1Identifieridentifier
... type 1..1CodeableConceptConsent
Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]}
... subType 0..1CodeableConceptType of consent

doco Documentation for this format

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract I0..*Contract
... 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..1Identifieridentifier
... status ?!∑0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... issued ∑0..1dateTimeWhen this Contract was issued
... applies ∑0..1PeriodEffective time
... subject ∑0..*Reference(Resource)Contract Target Entity
... topic ∑0..*Reference(Resource)Context of the Contract
... authority 0..*Reference(Organization)Authority under which this Contract has standing
... domain 0..*Reference(Location)Domain in which this Contract applies
... type ∑1..1CodeableConceptConsent
Binding: Contract Type Codes (example)
Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]}
... subType ∑0..1CodeableConceptType of consent
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptContract Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptContract Action Reason
Binding: PurposeOfUse (example)
... agent I0..*BackboneElementContract Agent
.... 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)Contract Agent Type
.... role 0..*CodeableConceptContract Agent Role
Binding: Contract Actor Role Codes (example)
... signer I0..*BackboneElementContract 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..1CodingContract Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Contract Signatory Party
.... signature 1..*SignatureContract Documentation Signature
... valuedItem I0..*BackboneElementContract Valued Item
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... entity[x] 0..1CodeableConcept, Reference(Resource)Contract Valued Item Type
.... identifier 0..1IdentifierContract Valued Item Identifier
.... effectiveTime 0..1dateTimeContract Valued Item Effective Tiem
.... quantity 0..1SimpleQuantityCount of Contract Valued Items
.... unitPrice 0..1MoneyContract Valued Item fee, charge, or cost
.... factor 0..1decimalContract Valued Item Price Scaling Factor
.... points 0..1decimalContract Valued Item Difficulty Scaling Factor
.... net 0..1MoneyTotal Contract Valued Item Value
... term I0..*BackboneElementContract 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..1IdentifierContract Term identifier
.... issued ∑0..1dateTimeContract Term Issue Date Time
.... applies ∑0..1PeriodContract Term Effective Time
.... type 0..1CodeableConceptContract Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptContract Term Subtype
Binding: Contract Term Type Codes (example)
.... topic ∑0..*Reference(Resource)Context of the Contract term
.... action 0..*CodeableConceptContract Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptContract Term Action Reason
Binding: PurposeOfUse (example)
.... agent I0..*BackboneElementContract Term Agent 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)Contract Term Agent List
..... role 0..*CodeableConceptContract Term Agent Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Contract term text
.... valuedItem I0..*BackboneElementContract Term Valued Item
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... entity[x] 0..1CodeableConcept, Reference(Resource)Contract Term Valued Item Type
..... identifier 0..1IdentifierContract Term Valued Item Identifier
..... effectiveTime 0..1dateTimeContract Term Valued Item Effective Tiem
..... quantity 0..1SimpleQuantityContract Term Valued Item Count
..... unitPrice 0..1MoneyContract Term Valued Item fee, charge, or cost
..... factor 0..1decimalContract Term Valued Item Price Scaling Factor
..... points 0..1decimalContract Term Valued Item Difficulty Scaling Factor
..... net 0..1MoneyTotal Contract Term Valued Item Value
.... group 0..*Unknown reference to #Contract:c-cdaonfhirconsent.term
Nested Contract Term Group
... binding[x] 0..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Contract
... friendly I0..*BackboneElementContract 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 Contract
... legal I0..*BackboneElementContract 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)Contract Legal Text
... rule I0..*BackboneElementComputable Contract 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 Contract Rules

doco Documentation for this format

This structure is derived from Contract

Summary

Mandatory: 1 element

Differential View

This structure is derived from Contract

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract 0..*
... identifier 0..1Identifieridentifier
... type 1..1CodeableConceptConsent
Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]}
... subType 0..1CodeableConceptType of consent

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Contract I0..*Contract
... 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..1Identifieridentifier
... status ?!∑0..1codeactive | cancelled | draft | entered-in-error
Binding: Financial Resource Status Codes (required)
... issued ∑0..1dateTimeWhen this Contract was issued
... applies ∑0..1PeriodEffective time
... subject ∑0..*Reference(Resource)Contract Target Entity
... topic ∑0..*Reference(Resource)Context of the Contract
... authority 0..*Reference(Organization)Authority under which this Contract has standing
... domain 0..*Reference(Location)Domain in which this Contract applies
... type ∑1..1CodeableConceptConsent
Binding: Contract Type Codes (example)
Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]}
... subType ∑0..1CodeableConceptType of consent
Binding: Contract Subtype Codes (example)
... action 0..*CodeableConceptContract Action
Binding: Contract Action Codes (example)
... actionReason 0..*CodeableConceptContract Action Reason
Binding: PurposeOfUse (example)
... agent I0..*BackboneElementContract Agent
.... 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)Contract Agent Type
.... role 0..*CodeableConceptContract Agent Role
Binding: Contract Actor Role Codes (example)
... signer I0..*BackboneElementContract 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..1CodingContract Signer Type
Binding: Contract Signer Type Codes (preferred)
.... party 1..1Reference(Organization), Reference(Patient), Reference(Practitioner), Reference(RelatedPerson)Contract Signatory Party
.... signature 1..*SignatureContract Documentation Signature
... valuedItem I0..*BackboneElementContract Valued Item
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
.... entity[x] 0..1CodeableConcept, Reference(Resource)Contract Valued Item Type
.... identifier 0..1IdentifierContract Valued Item Identifier
.... effectiveTime 0..1dateTimeContract Valued Item Effective Tiem
.... quantity 0..1SimpleQuantityCount of Contract Valued Items
.... unitPrice 0..1MoneyContract Valued Item fee, charge, or cost
.... factor 0..1decimalContract Valued Item Price Scaling Factor
.... points 0..1decimalContract Valued Item Difficulty Scaling Factor
.... net 0..1MoneyTotal Contract Valued Item Value
... term I0..*BackboneElementContract 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..1IdentifierContract Term identifier
.... issued ∑0..1dateTimeContract Term Issue Date Time
.... applies ∑0..1PeriodContract Term Effective Time
.... type 0..1CodeableConceptContract Term Type
Binding: Contract Term Type Codes (example)
.... subType 0..1CodeableConceptContract Term Subtype
Binding: Contract Term Type Codes (example)
.... topic ∑0..*Reference(Resource)Context of the Contract term
.... action 0..*CodeableConceptContract Term Action
Binding: Contract Action Codes (example)
.... actionReason 0..*CodeableConceptContract Term Action Reason
Binding: PurposeOfUse (example)
.... agent I0..*BackboneElementContract Term Agent 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)Contract Term Agent List
..... role 0..*CodeableConceptContract Term Agent Role
Binding: Contract Actor Role Codes (example)
.... text 0..1stringHuman readable Contract term text
.... valuedItem I0..*BackboneElementContract Term Valued Item
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
..... modifierExtension ?!∑0..*ExtensionExtensions that cannot be ignored
..... entity[x] 0..1CodeableConcept, Reference(Resource)Contract Term Valued Item Type
..... identifier 0..1IdentifierContract Term Valued Item Identifier
..... effectiveTime 0..1dateTimeContract Term Valued Item Effective Tiem
..... quantity 0..1SimpleQuantityContract Term Valued Item Count
..... unitPrice 0..1MoneyContract Term Valued Item fee, charge, or cost
..... factor 0..1decimalContract Term Valued Item Price Scaling Factor
..... points 0..1decimalContract Term Valued Item Difficulty Scaling Factor
..... net 0..1MoneyTotal Contract Term Valued Item Value
.... group 0..*Unknown reference to #Contract:c-cdaonfhirconsent.term
Nested Contract Term Group
... binding[x] 0..1Attachment, Reference(Composition), Reference(DocumentReference), Reference(QuestionnaireResponse)Binding Contract
... friendly I0..*BackboneElementContract 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 Contract
... legal I0..*BackboneElementContract 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)Contract Legal Text
... rule I0..*BackboneElementComputable Contract 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 Contract Rules

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON, CSV), Schema: XML Schematron

 

D.4.1.2 Terminology Bindings

Terminology Bindings

PathNameConformanceValueSet
Contract.languageCommon LanguagesextensibleCommon Languages
Contract.statusFinancial Resource Status CodesrequiredFinancial Resource Status Codes
Contract.typeContract Type CodesexampleContract Type Codes
Contract.subTypeContract Subtype CodesexampleContract Subtype Codes
Contract.actionContract Action CodesexampleContract Action Codes
Contract.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.agent.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 Type CodesexampleContract Term Type Codes
Contract.term.actionContract Action CodesexampleContract Action Codes
Contract.term.actionReasonPurposeOfUseexamplePurposeOfUse
Contract.term.agent.roleContract Actor Role CodesexampleContract Actor Role Codes

D.4.1.3 Constraints

Constraints

IdPathDetailsRequirements
dom-2ContractIf the resource is contained in another resource, it SHALL NOT contain nested Resources
XPath: not(parent::f:contained and f:contained)
dom-1ContractIf the resource is contained in another resource, it SHALL NOT contain any narrative
XPath: not(parent::f:contained and f:text)
dom-4ContractIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
XPath: not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
dom-3ContractIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource
XPath: not(exists(for $id in f:contained/*/@id return $id[not(ancestor::f:contained/parent::*/descendant::f:reference/@value=concat('#', $id))]))
ele-1Contract.agentAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.signerAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.valuedItemAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.termAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.term.agentAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.term.valuedItemAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.friendlyAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.legalAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
ele-1Contract.ruleAll FHIR elements must have a @value or children
XPath: @value|f:*|h:div
.