Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release
Clinical Document Architecture
2.0.0-sd-202406-matchbox-patch - release
Clinical Document Architecture - Local Development build (v2.0.0-sd-202406-matchbox-patch) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Active as of 2024-06-19 |
JSON representation of the Consent logical model.
{
"resourceType" : "StructureDefinition",
"id" : "Consent",
"text" : {
"status" : "generated",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\">\n <p>This class references the consents associated with this document. The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal "completed") and should be on file.</p>\n </div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-target",
"_valueBoolean" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/data-absent-reason",
"valueCode" : "not-applicable"
}
]
}
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:v3"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "consent"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/logical-container",
"valueUri" : "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueUri" : "cda"
}
],
"url" : "http://hl7.org/cda/stds/core/StructureDefinition/Consent",
"version" : "2.0.0-sd-202406-matchbox-patch",
"name" : "Consent",
"title" : "Consent (CDA Class)",
"status" : "active",
"experimental" : false,
"date" : "2024-06-19T17:47:42+02:00",
"publisher" : "Health Level 7",
"contact" : [
{
"name" : "HL7 International - Structured Documents",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/structure"
},
{
"system" : "email",
"value" : "structdog@lists.HL7.org"
}
]
}
],
"description" : "This class references the consents associated with this document. The type of consent (e.g. a consent to perform the related ServiceEvent, a consent for the information contained in the document to be released to a third party) is conveyed in Consent.code. Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal \"completed\") and should be on file.",
"fhirVersion" : "5.0.0",
"mapping" : [
{
"identity" : "rim",
"uri" : "http://hl7.org/v3",
"name" : "RIM Mapping"
}
],
"kind" : "logical",
"abstract" : false,
"type" : "http://hl7.org/cda/stds/core/StructureDefinition/Consent",
"baseDefinition" : "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot",
"derivation" : "specialization",
"snapshot" : {
"element" : [
{
"id" : "Consent",
"path" : "Consent",
"short" : "Base for all types and resources",
"definition" : "Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Base",
"min" : 0,
"max" : "*"
},
"isModifier" : false,
"mapping" : [
{
"identity" : "rim",
"map" : "n/a"
}
]
},
{
"id" : "Consent.nullFlavor",
"path" : "Consent.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Consent.realmCode",
"path" : "Consent.realmCode",
"definition" : "When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.realmCode",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
]
},
{
"id" : "Consent.typeId",
"path" : "Consent.typeId",
"definition" : "When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "InfrastructureRoot.typeId",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Consent.typeId.nullFlavor",
"path" : "Consent.typeId.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Consent.typeId.assigningAuthorityName",
"path" : "Consent.typeId.assigningAuthorityName",
"representation" : [
"xmlAttr"
],
"label" : "Assigning Authority Name",
"definition" : "A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.assigningAuthorityName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.typeId.displayable",
"path" : "Consent.typeId.displayable",
"representation" : [
"xmlAttr"
],
"label" : "Displayable",
"definition" : "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"min" : 0,
"max" : "1",
"base" : {
"path" : "II.displayable",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "boolean",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple"
]
}
]
},
{
"id" : "Consent.typeId.root",
"path" : "Consent.typeId.root",
"representation" : [
"xmlAttr"
],
"label" : "Root",
"definition" : "Identifies the type as an HL7 Registered model",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.root",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
],
"fixedString" : "2.16.840.1.113883.1.3"
},
{
"id" : "Consent.typeId.extension",
"path" : "Consent.typeId.extension",
"representation" : [
"xmlAttr"
],
"label" : "Extension",
"definition" : "A character string as a unique identifier within the scope of the identifier root.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "II.extension",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.templateId",
"path" : "Consent.templateId",
"definition" : "When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question",
"min" : 0,
"max" : "*",
"base" : {
"path" : "InfrastructureRoot.templateId",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Consent.classCode",
"path" : "Consent.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.classCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CONS",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "Consent.moodCode",
"path" : "Consent.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.moodCode",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "Consent.id",
"path" : "Consent.id",
"min" : 0,
"max" : "*",
"base" : {
"path" : "Consent.id",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Consent.code",
"path" : "Consent.code",
"min" : 0,
"max" : "1",
"base" : {
"path" : "Consent.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
},
{
"id" : "Consent.statusCode",
"path" : "Consent.statusCode",
"min" : 1,
"max" : "1",
"base" : {
"path" : "Consent.statusCode",
"min" : 1,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "Consent.statusCode.nullFlavor",
"path" : "Consent.statusCode.nullFlavor",
"representation" : [
"xmlAttr"
],
"label" : "Exceptional Value Detail",
"definition" : "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "ANY.nullFlavor",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor"
}
},
{
"id" : "Consent.statusCode.code",
"path" : "Consent.statusCode.code",
"representation" : [
"xmlAttr"
],
"label" : "Code",
"definition" : "The plain code symbol defined by the code system. For example, \"784.0\" is the code symbol of the ICD-9 code \"784.0\" for headache.",
"comment" : "Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal \"completed\") and should be on file.",
"min" : 1,
"max" : "1",
"base" : {
"path" : "CD.code",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "completed"
},
{
"id" : "Consent.statusCode.codeSystem",
"path" : "Consent.statusCode.codeSystem",
"representation" : [
"xmlAttr"
],
"label" : "Code System",
"definition" : "Specifies the code system that defines the code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystem",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/uuid"🔗 ,
"http://hl7.org/cda/stds/core/StructureDefinition/ruid"
]
}
]
},
{
"id" : "Consent.statusCode.codeSystemName",
"path" : "Consent.statusCode.codeSystemName",
"representation" : [
"xmlAttr"
],
"label" : "Code System Name",
"definition" : "The common name of the coding system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.statusCode.codeSystemVersion",
"path" : "Consent.statusCode.codeSystemVersion",
"representation" : [
"xmlAttr"
],
"label" : "Code System Version",
"definition" : "If applicable, a version descriptor defined specifically for the given code system.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.codeSystemVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.statusCode.displayName",
"path" : "Consent.statusCode.displayName",
"representation" : [
"xmlAttr"
],
"label" : "Display Name",
"definition" : "A name or title for the code, under which the sending system shows the code value to its users.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.displayName",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.statusCode.sdtcValueSet",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSet"
}
],
"path" : "Consent.statusCode.sdtcValueSet",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.valueSet",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/oid"
]
}
]
},
{
"id" : "Consent.statusCode.sdtcValueSetVersion",
"extension" : [
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri" : "urn:hl7-org:sdtc"
},
{
"url" : "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString" : "valueSetVersion"
}
],
"path" : "Consent.statusCode.sdtcValueSetVersion",
"representation" : [
"xmlAttr"
],
"definition" : "The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.",
"min" : 0,
"max" : "1",
"base" : {
"path" : "CD.sdtcValueSetVersion",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "string",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/st-simple"
]
}
]
},
{
"id" : "Consent.statusCode.originalText",
"path" : "Consent.statusCode.originalText",
"label" : "Original Text",
"definition" : "The text or phrase used as the basis for the coding.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.originalText",
"min" : 0,
"max" : "1"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id" : "Consent.statusCode.qualifier",
"path" : "Consent.statusCode.qualifier",
"label" : "Qualifier",
"definition" : "Specifies additional codes that increase the specificity of the the primary code.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.qualifier",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id" : "Consent.statusCode.translation",
"path" : "Consent.statusCode.translation",
"representation" : [
"typeAttr"
],
"label" : "Translation",
"definition" : "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min" : 0,
"max" : "0",
"base" : {
"path" : "CD.translation",
"min" : 0,
"max" : "*"
},
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
}
]
},
"differential" : {
"element" : [
{
"id" : "Consent",
"path" : "Consent",
"min" : 1,
"max" : "1"
},
{
"id" : "Consent.classCode",
"path" : "Consent.classCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "CONS",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActClass"
}
},
{
"id" : "Consent.moodCode",
"path" : "Consent.moodCode",
"representation" : [
"xmlAttr"
],
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "EVN",
"binding" : {
"strength" : "required",
"valueSet" : "http://hl7.org/cda/stds/core/ValueSet/CDAActMood"
}
},
{
"id" : "Consent.id",
"path" : "Consent.id",
"min" : 0,
"max" : "*",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id" : "Consent.code",
"path" : "Consent.code",
"min" : 0,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding" : {
"strength" : "example",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
},
{
"id" : "Consent.statusCode",
"path" : "Consent.statusCode",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding" : {
"strength" : "required",
"valueSet" : "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
},
{
"id" : "Consent.statusCode.code",
"path" : "Consent.statusCode.code",
"representation" : [
"xmlAttr"
],
"comment" : "Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal \"completed\") and should be on file.",
"min" : 1,
"max" : "1",
"type" : [
{
"code" : "code",
"profile" : [
🔗 "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple"
]
}
],
"fixedCode" : "completed"
}
]
}
}
IG © 2019+ Health Level 7. Package hl7.cda.uv.core#2.0.0-sd-202406-matchbox-patch based on FHIR 5.0.0. Generated 2024-06-19
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change