C-CDA on FHIR Implementation Guide STU 1 (v1.0.0)
This page is part of the C-CDA on FHIR Implementation Guide (v1.0.0: STU 1) based on FHIR R3. The current version which supercedes this version is 1.1.0. For a full list of available versions, see the Directory of published versions 
The official URL for this profile is:
http://hl7.org/fhir/us/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 Sat Apr 07 06:53:01 AEST 2018 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
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Contract | 0..* | |||
 identifier | 0..1 | Identifier | identifier | |
| type | 1..1 | CodeableConcept | Consent Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]} | |
 subType | 0..1 | CodeableConcept | Type of consent | |
| Documentation for this format | ||||
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | I | 0..* | Legal Agreement | |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
 contained | 0..* | Resource | Contained, inline Resources | |
 extension | 0..* | Extension | Additional Content defined by implementations | |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | identifier |
| status | ?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: Contract Resource Status Codes (required) |
| issued | Σ | 0..1 | dateTime | When this Contract was issued |
| applies | Σ | 0..1 | Period | Effective 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..1 | CodeableConcept | Consent Binding: Contract Type Codes (example) Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]} |
| subType | Σ | 0..1 | CodeableConcept | Type of consent Binding: Contract Subtype Codes (example) |
| action | 0..* | CodeableConcept | Action stipulated by this Contract Binding: Contract Action Codes (example) | |
| actionReason | 0..* | CodeableConcept | Rationale for the stiplulated action Binding: PurposeOfUse (example) | |
| decisionType | 0..1 | CodeableConcept | Decision by Grantor Binding: ActConsentDirective (extensible) | |
| contentDerivative | 0..1 | CodeableConcept | Content derived from the basal information Binding: Contract Content Derivation Codes (example) | |
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
| agent | I | 0..* | BackboneElement | Entity being ascribed responsibility |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Agent Type | |
| role | 0..* | CodeableConcept | Role type of the agent Binding: Contract Actor Role Codes (example) | |
| signer | I | 0..* | BackboneElement | Contract Signatory |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | 1..1 | Coding | Contract Signatory Role Binding: Contract Signer Type Codes (preferred) | |
| party | 1..1 | Reference(Organization | Patient | Practitioner | RelatedPerson) | Contract Signatory Party | |
| signature | 1..* | Signature | Contract Documentation Signature | |
| valuedItem | I | 0..* | BackboneElement | Contract Valued Item List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
 entity[x] | 0..1 | CodeableConcept, Reference(Resource) | Contract Valued Item Type | |
| identifier | 0..1 | Identifier | Contract Valued Item Number | |
| effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |
| quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |
| unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |
| factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |
| points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |
| net | 0..1 | Money | Total Contract Valued Item Value | |
| term | I | 0..* | BackboneElement | Contract Term List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Contract Term Number |
| issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time |
| applies | Σ | 0..1 | Period | Contract Term Effective Time |
| type | 0..1 | CodeableConcept | Contract Term Type or Form Binding: Contract Term Type Codes (example) | |
| subType | 0..1 | CodeableConcept | Contract Term Type specific classification Binding: Contract Term Subtype Codes (example) | |
| topic | Σ | 0..* | Reference(Resource) | Context of the Contract term |
| action | 0..* | CodeableConcept | Contract Term Activity Binding: Contract Action Codes (example) | |
| actionReason | 0..* | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example) | |
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected terms Binding: All Security Labels (extensible) |
| agent | I | 0..* | BackboneElement | Contract Term Agent List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Term Agent Subject | |
| role | 0..* | CodeableConcept | Type of the Contract Term Agent Binding: Contract Actor Role Codes (example) | |
| text | 0..1 | string | Human readable Contract term text | |
| valuedItem | I | 0..* | BackboneElement | Contract Term Valued Item List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| entity[x] | 0..1 | CodeableConcept, Reference(Resource) | Contract Term Valued Item Type | |
| identifier | 0..1 | Identifier | Contract Term Valued Item Number | |
| effectiveTime | 0..1 | dateTime | Contract Term Valued Item Effective Tiem | |
| quantity | 0..1 | SimpleQuantity | Contract Term Valued Item Count | |
| unitPrice | 0..1 | Money | Contract Term Valued Item fee, charge, or cost | |
| factor | 0..1 | decimal | Contract Term Valued Item Price Scaling Factor | |
| points | 0..1 | decimal | Contract Term Valued Item Difficulty Scaling Factor | |
| net | 0..1 | Money | Total Contract Term Valued Item Value | |
| group | 0..* | Unknown reference to #Contract.term Nested Contract Term Group | ||
| binding[x] | 0..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Binding Contract | |
| friendly | I | 0..* | BackboneElement | Contract Friendly Language |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Easily comprehended representation of this Contract | |
| legal | I | 0..* | BackboneElement | Contract Legal Language |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Contract Legal Text | |
| rule | I | 0..* | BackboneElement | Computable Contract Language |
 id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(DocumentReference) | Computable Contract Rules | |
| Documentation for this format | ||||
This structure is derived from Contract
Differential View
This structure is derived from Contract
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | 0..* | |||
| identifier | 0..1 | Identifier | identifier | |
| type | 1..1 | CodeableConcept | Consent Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]} | |
| subType | 0..1 | CodeableConcept | Type of consent | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Contract | I | 0..* | Legal Agreement | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: Common Languages (extensible) | |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | identifier |
| status | ?!Σ | 0..1 | code | amended | appended | cancelled | disputed | entered-in-error | executable | executed | negotiable | offered | policy | rejected | renewed | revoked | resolved | terminated Binding: Contract Resource Status Codes (required) |
| issued | Σ | 0..1 | dateTime | When this Contract was issued |
| applies | Σ | 0..1 | Period | Effective 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..1 | CodeableConcept | Consent Binding: Contract Type Codes (example) Required Pattern: {"coding":[{"system":"urn:oid:2.16.840.1.113883.5.6","code":"CONS"}]} |
| subType | Σ | 0..1 | CodeableConcept | Type of consent Binding: Contract Subtype Codes (example) |
| action | 0..* | CodeableConcept | Action stipulated by this Contract Binding: Contract Action Codes (example) | |
| actionReason | 0..* | CodeableConcept | Rationale for the stiplulated action Binding: PurposeOfUse (example) | |
| decisionType | 0..1 | CodeableConcept | Decision by Grantor Binding: ActConsentDirective (extensible) | |
| contentDerivative | 0..1 | CodeableConcept | Content derived from the basal information Binding: Contract Content Derivation Codes (example) | |
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected resources Binding: All Security Labels (extensible) |
| agent | I | 0..* | BackboneElement | Entity being ascribed responsibility |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Agent Type | |
| role | 0..* | CodeableConcept | Role type of the agent Binding: Contract Actor Role Codes (example) | |
| signer | I | 0..* | BackboneElement | Contract Signatory |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| type | 1..1 | Coding | Contract Signatory Role Binding: Contract Signer Type Codes (preferred) | |
| party | 1..1 | Reference(Organization | Patient | Practitioner | RelatedPerson) | Contract Signatory Party | |
| signature | 1..* | Signature | Contract Documentation Signature | |
| valuedItem | I | 0..* | BackboneElement | Contract Valued Item List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| entity[x] | 0..1 | CodeableConcept, Reference(Resource) | Contract Valued Item Type | |
| identifier | 0..1 | Identifier | Contract Valued Item Number | |
| effectiveTime | 0..1 | dateTime | Contract Valued Item Effective Tiem | |
| quantity | 0..1 | SimpleQuantity | Count of Contract Valued Items | |
| unitPrice | 0..1 | Money | Contract Valued Item fee, charge, or cost | |
| factor | 0..1 | decimal | Contract Valued Item Price Scaling Factor | |
| points | 0..1 | decimal | Contract Valued Item Difficulty Scaling Factor | |
| net | 0..1 | Money | Total Contract Valued Item Value | |
| term | I | 0..* | BackboneElement | Contract Term List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | 0..1 | Identifier | Contract Term Number |
| issued | Σ | 0..1 | dateTime | Contract Term Issue Date Time |
| applies | Σ | 0..1 | Period | Contract Term Effective Time |
| type | 0..1 | CodeableConcept | Contract Term Type or Form Binding: Contract Term Type Codes (example) | |
| subType | 0..1 | CodeableConcept | Contract Term Type specific classification Binding: Contract Term Subtype Codes (example) | |
| topic | Σ | 0..* | Reference(Resource) | Context of the Contract term |
| action | 0..* | CodeableConcept | Contract Term Activity Binding: Contract Action Codes (example) | |
| actionReason | 0..* | CodeableConcept | Purpose for the Contract Term Action Binding: PurposeOfUse (example) | |
| securityLabel | Σ | 0..* | Coding | Security Labels that define affected terms Binding: All Security Labels (extensible) |
| agent | I | 0..* | BackboneElement | Contract Term Agent List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| actor | 1..1 | Reference(Contract | Device | Group | Location | Organization | Patient | Practitioner | RelatedPerson | Substance) | Contract Term Agent Subject | |
| role | 0..* | CodeableConcept | Type of the Contract Term Agent Binding: Contract Actor Role Codes (example) | |
| text | 0..1 | string | Human readable Contract term text | |
| valuedItem | I | 0..* | BackboneElement | Contract Term Valued Item List |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| entity[x] | 0..1 | CodeableConcept, Reference(Resource) | Contract Term Valued Item Type | |
| identifier | 0..1 | Identifier | Contract Term Valued Item Number | |
| effectiveTime | 0..1 | dateTime | Contract Term Valued Item Effective Tiem | |
| quantity | 0..1 | SimpleQuantity | Contract Term Valued Item Count | |
| unitPrice | 0..1 | Money | Contract Term Valued Item fee, charge, or cost | |
| factor | 0..1 | decimal | Contract Term Valued Item Price Scaling Factor | |
| points | 0..1 | decimal | Contract Term Valued Item Difficulty Scaling Factor | |
| net | 0..1 | Money | Total Contract Term Valued Item Value | |
| group | 0..* | Unknown reference to #Contract.term Nested Contract Term Group | ||
| binding[x] | 0..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Binding Contract | |
| friendly | I | 0..* | BackboneElement | Contract Friendly Language |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Easily comprehended representation of this Contract | |
| legal | I | 0..* | BackboneElement | Contract Legal Language |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(Composition | DocumentReference | QuestionnaireResponse) | Contract Legal Text | |
| rule | I | 0..* | BackboneElement | Computable Contract Language |
| id | 0..1 | string | xml:id (or equivalent in JSON) | |
| extension | 0..* | Extension | Additional Content defined by implementations | |
| modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored |
| content[x] | 1..1 | Attachment, Reference(DocumentReference) | Computable Contract Rules | |
| Documentation for this format | ||||
| Path | Name | Conformance | ValueSet |
| Contract.language | Common Languages | extensible | Common Languages |
| Contract.status | Contract Resource Status Codes | required | Contract Resource Status Codes |
| Contract.type | Contract Type Codes | example | Contract Type Codes |
| Contract.subType | Contract Subtype Codes | example | Contract Subtype Codes |
| Contract.action | Contract Action Codes | example | Contract Action Codes |
| Contract.actionReason | PurposeOfUse | example | PurposeOfUse |
| Contract.decisionType | ActConsentDirective | extensible | ActConsentDirective |
| Contract.contentDerivative | Contract Content Derivation Codes | example | Contract Content Derivation Codes |
| Contract.securityLabel | All Security Labels | extensible | All Security Labels |
| Contract.agent.role | Contract Actor Role Codes | example | Contract Actor Role Codes |
| Contract.signer.type | Contract Signer Type Codes | preferred | Contract Signer Type Codes |
| Contract.term.type | Contract Term Type Codes | example | Contract Term Type Codes |
| Contract.term.subType | Contract Term Subtype Codes | example | Contract Term Subtype Codes |
| Contract.term.action | Contract Action Codes | example | Contract Action Codes |
| Contract.term.actionReason | PurposeOfUse | example | PurposeOfUse |
| Contract.term.securityLabel | All Security Labels | extensible | All Security Labels |
| Contract.term.agent.role | Contract Actor Role Codes | example | Contract Actor Role Codes |
| Id | Path | Details | Requirements |
| dom-2 | Contract | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-1 | Contract | If the resource is contained in another resource, it SHALL NOT contain any narrative : contained.text.empty() | |
| dom-4 | Contract | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty() | |
| dom-3 | Contract | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource : contained.where(('#'+id in %resource.descendants().reference).not()).empty() | |
| ele-1 | Contract.agent | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.signer | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.valuedItem | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.term | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.term.agent | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.term.valuedItem | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.friendly | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.legal | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) | |
| ele-1 | Contract.rule | All FHIR elements must have a @value or children : hasValue() | (children().count() > id.count()) |
© HL7.org 2011+. C-CDA on FHIR Implementation Guide v1.0.0 based on FHIR version (v3.0.1) generated on
Sat, Apr 7, 2018 06:53+1000. QA Page
Links: Search | Version History | Table of Contents
| 
| Propose a change