{ "description": "This class represents those orders that are fulfilled by this document. For instance, a provider orders an X-Ray. The X-Ray is performed. A radiologist reads the X-Ray and generates a report. The X-Ray order identifier is transmitted in the Order class, the performed X-Ray procedure is transmitted in the ServiceEvent class, and the ClinicalDocument.code would be valued with \\\"Diagnostic Imaging Report\\\".", "_filename": "StructureDefinition-Order.json", "package_name": "hl7.cda.uv.core", "date": "2024-12-18T12:03:45+11:00", "derivation": "specialization", "publisher": "Health Level 7", "fhirVersion": "5.0.0", "name": "Order", "mapping": [ { "uri": "http://hl7.org/v3", "name": "RIM Mapping", "identity": "rim" } ], "abstract": false, "type": "http://hl7.org/cda/stds/core/StructureDefinition/Order", "experimental": "false", "resourceType": "StructureDefinition", "title": "Order (CDA Class)", "package_version": "2.0.1-sd", "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": "order" }, { "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": "Order", "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": "Order", "base": { "max": "*", "min": 0, "path": "Base" } }, { "path": "Order.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": "Order.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "id": "Order.realmCode", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.realmCode" }, "path": "Order.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": "Order.typeId", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "InfrastructureRoot.typeId" }, "path": "Order.typeId", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ], "constraint": [ { "key": "II-1", "human": "An II instance must have either a root or an nullFlavor.", "source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot", "severity": "error", "expression": "root.exists() or nullFlavor.exists()" } ], "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": "Order.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": "Order.typeId.nullFlavor", "base": { "max": "1", "min": 0, "path": "ANY.nullFlavor" } }, { "path": "Order.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": "Order.typeId.assigningAuthorityName", "base": { "max": "1", "min": 0, "path": "II.assigningAuthorityName" } }, { "path": "Order.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": "Order.typeId.displayable", "base": { "max": "1", "min": 0, "path": "II.displayable" } }, { "path": "Order.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": "Order.typeId.root", "base": { "max": "1", "min": 0, "path": "II.root" } }, { "path": "Order.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": "Order.typeId.extension", "base": { "max": "1", "min": 0, "path": "II.extension" } }, { "id": "Order.templateId", "max": "*", "min": 0, "base": { "max": "*", "min": 0, "path": "InfrastructureRoot.templateId" }, "path": "Order.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": "Order.classCode", "min": 0, "defaultValueCode": "ACT", "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass" }, "representation": [ "xmlAttr" ], "max": "1", "id": "Order.classCode", "base": { "max": "1", "min": 0, "path": "Order.classCode" } }, { "path": "Order.moodCode", "fixedCode": "RQO", "min": 0, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent" }, "representation": [ "xmlAttr" ], "max": "1", "id": "Order.moodCode", "base": { "max": "1", "min": 0, "path": "Order.moodCode" } }, { "id": "Order.id", "max": "*", "min": 1, "base": { "max": "*", "min": 1, "path": "Order.id" }, "path": "Order.id", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Order.code", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "Order.code" }, "path": "Order.code", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, { "id": "Order.priorityCode", "max": "1", "min": 0, "base": { "max": "1", "min": 0, "path": "Order.priorityCode" }, "path": "Order.priorityCode", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority" } } ] }, "status": "active", "id": "4dbb0653-7157-4e64-96a7-4080849fad26", "kind": "logical", "url": "http://hl7.org/cda/stds/core/StructureDefinition/Order", "version": "2.0.1-sd", "differential": { "element": [ { "id": "Order", "max": "1", "min": 1, "path": "Order" }, { "id": "Order.classCode", "max": "1", "min": 0, "path": "Order.classCode", "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass" }, "representation": [ "xmlAttr" ], "defaultValueCode": "ACT" }, { "id": "Order.moodCode", "max": "1", "min": 0, "path": "Order.moodCode", "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActMoodIntent" }, "fixedCode": "RQO", "representation": [ "xmlAttr" ] }, { "id": "Order.id", "max": "*", "min": 1, "path": "Order.id", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Order.code", "max": "1", "min": 0, "path": "Order.code", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode" } }, { "id": "Order.priorityCode", "max": "1", "min": 0, "path": "Order.priorityCode", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority" } } ] }, "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" }