{
"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.",
"_filename": "StructureDefinition-Consent.json",
"package_name": "hl7.cda.uv.core",
"date": "2023-12-16T11:59:27-05:00",
"derivation": "specialization",
"publisher": "Health Level 7",
"fhirVersion": "5.0.0",
"name": "Consent",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
} ],
"abstract": false,
"type": "http://hl7.org/cda/stds/core/StructureDefinition/Consent",
"experimental": "false",
"resourceType": "StructureDefinition",
"title": "Consent (CDA Class)",
"package_version": "2.0.0-sd-snapshot1",
"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"
} ],
"snapshot": {
"element": [ {
"path": "Consent",
"min": 1,
"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.",
"isModifier": false,
"short": "Base for all types and resources",
"mapping": [ {
"map": "n/a",
"identity": "rim"
} ],
"max": "1",
"id": "Consent",
"base": {
"max": "*",
"min": 0,
"path": "Base"
}
}, {
"path": "Consent.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Consent.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"id": "Consent.realmCode",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.realmCode"
},
"path": "Consent.realmCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"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"
}, {
"id": "Consent.typeId",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "InfrastructureRoot.typeId"
},
"path": "Consent.typeId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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."
}, {
"path": "Consent.typeId.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Consent.typeId.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Consent.typeId.assigningAuthorityName",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Assigning Authority Name",
"id": "Consent.typeId.assigningAuthorityName",
"base": {
"max": "1",
"min": 0,
"path": "II.assigningAuthorityName"
}
}, {
"path": "Consent.typeId.displayable",
"min": 0,
"definition": "Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).",
"type": [ {
"code": "boolean",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Displayable",
"id": "Consent.typeId.displayable",
"base": {
"max": "1",
"min": 0,
"path": "II.displayable"
}
}, {
"path": "Consent.typeId.root",
"min": 1,
"definition": "Identifies the type as an HL7 Registered model",
"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" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"fixedString": "2.16.840.1.113883.1.3",
"label": "Root",
"id": "Consent.typeId.root",
"base": {
"max": "1",
"min": 0,
"path": "II.root"
}
}, {
"path": "Consent.typeId.extension",
"min": 1,
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Extension",
"id": "Consent.typeId.extension",
"base": {
"max": "1",
"min": 0,
"path": "II.extension"
}
}, {
"id": "Consent.templateId",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "InfrastructureRoot.templateId"
},
"path": "Consent.templateId",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ],
"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"
}, {
"path": "Consent.classCode",
"fixedCode": "CONS",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClass"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.classCode",
"base": {
"max": "1",
"min": 0,
"path": "Consent.classCode"
}
}, {
"path": "Consent.moodCode",
"fixedCode": "EVN",
"min": 0,
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
},
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.moodCode",
"base": {
"max": "1",
"min": 0,
"path": "Consent.moodCode"
}
}, {
"id": "Consent.id",
"max": "*",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "Consent.id"
},
"path": "Consent.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Consent.code",
"max": "1",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "Consent.code"
},
"path": "Consent.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
}, {
"id": "Consent.statusCode",
"max": "1",
"min": 1,
"base": {
"max": "1",
"min": 1,
"path": "Consent.statusCode"
},
"path": "Consent.statusCode",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus"
}
}, {
"path": "Consent.statusCode.nullFlavor",
"min": 0,
"definition": "If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.",
"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"
},
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Exceptional Value Detail",
"id": "Consent.statusCode.nullFlavor",
"base": {
"max": "1",
"min": 0,
"path": "ANY.nullFlavor"
}
}, {
"path": "Consent.statusCode.code",
"fixedCode": "completed",
"min": 1,
"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.",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"label": "Code",
"id": "Consent.statusCode.code",
"comment": "Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal \"completed\") and should be on file.",
"base": {
"max": "1",
"min": 0,
"path": "CD.code"
}
}, {
"path": "Consent.statusCode.codeSystem",
"min": 0,
"definition": "Specifies the code system that defines the code.",
"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" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System",
"id": "Consent.statusCode.codeSystem",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystem"
}
}, {
"path": "Consent.statusCode.codeSystemName",
"min": 0,
"definition": "The common name of the coding system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Name",
"id": "Consent.statusCode.codeSystemName",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemName"
}
}, {
"path": "Consent.statusCode.codeSystemVersion",
"min": 0,
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Code System Version",
"id": "Consent.statusCode.codeSystemVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.codeSystemVersion"
}
}, {
"path": "Consent.statusCode.displayName",
"min": 0,
"definition": "A name or title for the code, under which the sending system shows the code value to its users.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"representation": [ "xmlAttr" ],
"max": "0",
"label": "Display Name",
"id": "Consent.statusCode.displayName",
"base": {
"max": "1",
"min": 0,
"path": "CD.displayName"
}
}, {
"path": "Consent.statusCode.sdtcValueSet",
"min": 0,
"definition": "The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/oid" ]
} ],
"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"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.statusCode.sdtcValueSet",
"base": {
"max": "1",
"min": 0,
"path": "CD.valueSet"
}
}, {
"path": "Consent.statusCode.sdtcValueSetVersion",
"min": 0,
"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.",
"type": [ {
"code": "string",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/st-simple" ]
} ],
"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"
} ],
"representation": [ "xmlAttr" ],
"max": "1",
"id": "Consent.statusCode.sdtcValueSetVersion",
"base": {
"max": "1",
"min": 0,
"path": "CD.sdtcValueSetVersion"
}
}, {
"id": "Consent.statusCode.originalText",
"max": "0",
"min": 0,
"base": {
"max": "1",
"min": 0,
"path": "CD.originalText"
},
"path": "Consent.statusCode.originalText",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
} ],
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding."
}, {
"id": "Consent.statusCode.qualifier",
"max": "0",
"min": 0,
"base": {
"max": "*",
"min": 0,
"path": "CD.qualifier"
},
"path": "Consent.statusCode.qualifier",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
} ],
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code."
}, {
"path": "Consent.statusCode.translation",
"min": 0,
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
} ],
"representation": [ "typeAttr" ],
"max": "0",
"label": "Translation",
"id": "Consent.statusCode.translation",
"base": {
"max": "*",
"min": 0,
"path": "CD.translation"
}
} ]
},
"status": "active",
"id": "02508c26-be0e-4e0e-80ec-5442209220be",
"kind": "logical",
"url": "http://hl7.org/cda/stds/core/StructureDefinition/Consent",
"version": "2.0.0-sd-snapshot1",
"differential": {
"element": [ {
"id": "Consent",
"max": "1",
"min": 1,
"path": "Consent"
}, {
"id": "Consent.classCode",
"max": "1",
"min": 0,
"path": "Consent.classCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActClass"
},
"fixedCode": "CONS",
"representation": [ "xmlAttr" ]
}, {
"id": "Consent.moodCode",
"max": "1",
"min": 0,
"path": "Consent.moodCode",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActMood"
},
"fixedCode": "EVN",
"representation": [ "xmlAttr" ]
}, {
"id": "Consent.id",
"max": "*",
"min": 0,
"path": "Consent.id",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
} ]
}, {
"id": "Consent.code",
"max": "1",
"min": 0,
"path": "Consent.code",
"type": [ {
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode"
}
}, {
"id": "Consent.statusCode",
"max": "1",
"min": 1,
"path": "Consent.statusCode",
"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",
"max": "1",
"min": 1,
"path": "Consent.statusCode.code",
"type": [ {
"code": "code",
"profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ]
} ],
"comment": "Consents referenced in the CDA Header have been finalized (Consent.statusCode must equal \"completed\") and should be on file.",
"fixedCode": "completed",
"representation": [ "xmlAttr" ]
} ]
},
"contact": [ {
"name": "HL7 International - Structured Documents",
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/structure",
"system": "url"
}, {
"value": "structdog@lists.HL7.org",
"system": "email"
} ]
} ],
"baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot"
}