FHIR IG analytics| Package | hl7.cda.us.adi |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-External.Entry.Reference.Entry.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/HL7/cda-adi/StructureDefinition-External.Entry.Reference.Entry.html |
| URL | http://hl7.org/cda/us/adi/StructureDefinition/External.Entry.Reference.Entry |
| Version | 0.1.0 |
| Status | draft |
| Date | 2026-07-01T14:14:06+00:00 |
| Name | External_Entry_Reference_Entry |
| Title | ADI External Entry Reference Entry |
| Realm | us |
| Authority | hl7 |
| Description | This entry represents the act of referencing another an external entry not include in this CDA document instance. |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Act |
| Kind | logical |
| StructureDefinition | ||
| hl7.cda.us.adi#current | AdditionalDocumentationSection | Additional Documentation Section |
| hl7.cda.us.adi#current | AdministrativeInformationSection | Administrative Information Section |
| hl7.cda.us.adi#current | CareExperiencePreferencesSection | Care Experience Preferences Section |
| hl7.cda.us.adi#current | CompletionInformationSection | Completion Information Section |
| hl7.cda.us.adi#current | HealthcareAgentAppointmentSection | Healthcare Agent Appointment Section |
| hl7.cda.us.adi#current | PlannedProceduresPMOSection | Planned Procedure PMO Section |
| hl7.cda.us.adi#current | SourceFormSection | Source Form Section |
| hl7.cda.us.adi#current | TreatmentInterventionPreferencesSection | Treatment Intervention Preferences Section |
| hl7.cda.us.adi#current | UponDeathPreferencesSection | Upon Death Preferences Section |
| hl7.cda.us.adi#current | WitnessAndNotarySection | Witness And Notary Section |
| StructureDefinition | ||
| hl7.cda.us.ccda#current | EntryReference | Entry Reference |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition External.Entry.Reference.Entry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Act | C | 1..1 | EntryReference | XML Namespace: urn:hl7-org:v3 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
  Slices for templateId | 2..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:external-entry-reference | 1..1 | II | ||
  @root | 1..1 | oid(2.0.3-sd), uuid(2.0.3-sd), ruid(2.0.3-sd) | Required Pattern: 2.16.840.1.113883.4.823.1.4.2.5 | |
  @extension | 1..1 | st(2.0.3-sd) | Required Pattern: 2026-08-28 | |
| id | 1..* | II | When using a FHIR Collection Bundle for the entries, use the Resource name/Resource id as the id value. For example, if the entry is a FHIR Patient resource with id 123, then the id value would be 'Condition/123'. | |
| text | 0..1 | ED | links to the rendering of the entry information contained in the externally referenced Resource. | |
 reference | C | 0..1 | TEL | Constraints: value-starts-octothorpe |
| reference | 1..1 | Reference | ||
| @typeCode | 1..1 | cs(2.0.3-sd) | Fixed Value: REFR | |
| externalAct | 0..1 | ExternalAct | ||
| externalObservation | 0..1 | ExternalObservation | ||
| externalProcedure | 0..1 | ExternalProcedure | ||
| externalDocument | 0..1 | ExternalDocument | ||
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "External.Entry.Reference.Entry",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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/logical-container",
"valueUri": "http://hl7.org/cda/stds/core/StructureDefinition/ClinicalDocument"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace",
"valueUri": "urn:hl7-org:v3"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name",
"valueString": "act"
},
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/type-profile-style",
"valueCode": "cda"
}
],
"url": "http://hl7.org/cda/us/adi/StructureDefinition/External.Entry.Reference.Entry",
"identifier": [
{
"system": "urn:ietf:rfc:3986",
"value": "urn:hl7ii:2.16.840.1.113883.4.823.1.4.2.5:2026-08-28"
}
],
"version": "0.1.0",
"name": "External_Entry_Reference_Entry",
"title": "ADI External Entry Reference Entry",
"status": "draft",
"date": "2026-07-01T14:14:06+00:00",
"publisher": "Health Level Seven",
"contact": [
{
"name": "Health Level Seven",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/structure"
}
]
}
],
"description": "This entry represents the act of referencing another an external entry not include in this CDA document instance.",
"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/Act",
"baseDefinition": "http://hl7.org/cda/us/ccda/StructureDefinition/EntryReference",
"derivation": "constraint",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Act",
"path": "Act",
"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": "*"
},
"constraint": [
{
"key": "should-text-ref-value",
"severity": "warning",
"human": "SHOULD contain text/reference/@value",
"expression": "text.reference.value.exists()",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/EntryReference"
}
],
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Act.nullFlavor",
"path": "Act.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.realmCode",
"path": "Act.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": "Act.typeId",
"path": "Act.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"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot|2.0.3-sd"
}
]
},
{
"id": "Act.typeId.nullFlavor",
"path": "Act.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.typeId.assigningAuthorityName",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.typeId.displayable",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.typeId.root",
"path": "Act.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|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Act.typeId.extension",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId",
"path": "Act.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
},
"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": 2,
"max": "*",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Act.templateId:entry-reference",
"path": "Act.templateId",
"sliceName": "entry-reference",
"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": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Act.templateId:entry-reference.nullFlavor",
"path": "Act.templateId.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.templateId:entry-reference.assigningAuthorityName",
"path": "Act.templateId.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId:entry-reference.displayable",
"path": "Act.templateId.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId:entry-reference.root",
"path": "Act.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
],
"patternString": "2.16.840.1.113883.10.20.22.4.122"
},
{
"id": "Act.templateId:entry-reference.extension",
"path": "Act.templateId.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "0",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId:external-entry-reference",
"path": "Act.templateId",
"sliceName": "external-entry-reference",
"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": 1,
"max": "1",
"base": {
"path": "InfrastructureRoot.templateId",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Act.templateId:external-entry-reference.nullFlavor",
"path": "Act.templateId.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.templateId:external-entry-reference.assigningAuthorityName",
"path": "Act.templateId.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId:external-entry-reference.displayable",
"path": "Act.templateId.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.templateId:external-entry-reference.root",
"path": "Act.templateId.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 1,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
],
"patternString": "2.16.840.1.113883.4.823.1.4.2.5"
},
{
"id": "Act.templateId:external-entry-reference.extension",
"path": "Act.templateId.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|2.0.3-sd"
]
}
],
"patternString": "2026-08-28"
},
{
"id": "Act.classCode",
"path": "Act.classCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @classCode=\"ACT\" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6) (CONF:1098-31485).",
"min": 1,
"max": "1",
"base": {
"path": "Act.classCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "ACT",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0"
}
},
{
"id": "Act.moodCode",
"path": "Act.moodCode",
"representation": [
"xmlAttr"
],
"comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001) (CONF:1098-31486).",
"min": 1,
"max": "1",
"base": {
"path": "Act.moodCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "EVN",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0"
}
},
{
"id": "Act.negationInd",
"path": "Act.negationInd",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "Act.negationInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bl-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.id",
"path": "Act.id",
"short": "When using a FHIR Collection Bundle for the entries, use the Resource name/Resource id as the id value. For example, \nif the entry is a FHIR Patient resource with id 123, then the id value would be 'Condition/123'.",
"comment": "MUST contain at least one [1..*] id.",
"min": 1,
"max": "*",
"base": {
"path": "Act.id",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/II"
}
]
},
{
"id": "Act.id.nullFlavor",
"path": "Act.id.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": "0",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.id.assigningAuthorityName",
"path": "Act.id.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.id.displayable",
"path": "Act.id.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.id.root",
"path": "Act.id.root",
"representation": [
"xmlAttr"
],
"label": "Root",
"definition": "A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.",
"min": 0,
"max": "1",
"base": {
"path": "II.root",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
]
},
{
"id": "Act.id.extension",
"path": "Act.id.extension",
"representation": [
"xmlAttr"
],
"label": "Extension",
"definition": "A character string as a unique identifier within the scope of the identifier root.",
"min": 0,
"max": "1",
"base": {
"path": "II.extension",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.code",
"path": "Act.code",
"comment": "SHALL contain exactly one [1..1] code (CONF:1098-31490).",
"min": 1,
"max": "1",
"base": {
"path": "Act.code",
"min": 1,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActCode|3.0.0"
}
},
{
"id": "Act.code.nullFlavor",
"path": "Act.code.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.",
"comment": "This code SHALL contain exactly one [1..1] @nullFlavor=\"NP\" Not Present (CodeSystem: HL7NullFlavor urn:oid:2.16.840.1.113883.5.1008) (CONF:1098-31491).",
"min": 1,
"max": "1",
"base": {
"path": "ANY.nullFlavor",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "NP",
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.code.code",
"path": "Act.code.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.",
"min": 0,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.codeSystem",
"path": "Act.code.codeSystem",
"representation": [
"xmlAttr"
],
"label": "Code System",
"definition": "Specifies the code system that defines the code.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystem",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/oid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.codeSystemName",
"path": "Act.code.codeSystemName",
"representation": [
"xmlAttr"
],
"label": "Code System Name",
"definition": "The common name of the coding system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.codeSystemVersion",
"path": "Act.code.codeSystemVersion",
"representation": [
"xmlAttr"
],
"label": "Code System Version",
"definition": "If applicable, a version descriptor defined specifically for the given code system.",
"min": 0,
"max": "1",
"base": {
"path": "CD.codeSystemVersion",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.displayName",
"path": "Act.code.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": "1",
"base": {
"path": "CD.displayName",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.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": "Act.code.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.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": "Act.code.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.code.originalText",
"path": "Act.code.originalText",
"label": "Original Text",
"definition": "The text or phrase used as the basis for the coding.",
"min": 0,
"max": "1",
"base": {
"path": "CD.originalText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
]
},
{
"id": "Act.code.qualifier",
"path": "Act.code.qualifier",
"label": "Qualifier",
"definition": "Specifies additional codes that increase the specificity of the the primary code.",
"min": 0,
"max": "*",
"base": {
"path": "CD.qualifier",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CR"
}
]
},
{
"id": "Act.code.translation",
"path": "Act.code.translation",
"representation": [
"typeAttr"
],
"label": "Translation",
"definition": "A set of other concept descriptors that translate this concept descriptor into other code systems.",
"min": 0,
"max": "*",
"base": {
"path": "CD.translation",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CD"
}
]
},
{
"id": "Act.text",
"path": "Act.text",
"short": "links to the rendering of the entry information contained in the externally referenced Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Act.text",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
],
"condition": [
"should-text-ref-value"
]
},
{
"id": "Act.text.nullFlavor",
"path": "Act.text.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.text.compression",
"path": "Act.text.compression",
"representation": [
"xmlAttr"
],
"label": "Compression",
"definition": "Indicates whether the raw byte data is compressed, and what compression algorithm was used.",
"min": 0,
"max": "1",
"base": {
"path": "ED.compression",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm|2.0.3-sd"
}
},
{
"id": "Act.text.integrityCheck",
"path": "Act.text.integrityCheck",
"representation": [
"xmlAttr"
],
"label": "Integrity Check",
"definition": "The integrity check is a short binary value representing a cryptographically strong checksum that is calculated over the binary data. The purpose of this property, when communicated with a reference is for anyone to validate later whether the reference still resolved to the same data that the reference resolved to when the encapsulated data value with reference was created.",
"min": 0,
"max": "1",
"base": {
"path": "ED.integrityCheck",
"min": 0,
"max": "1"
},
"type": [
{
"code": "base64Binary",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/bin|2.0.3-sd"
]
}
]
},
{
"id": "Act.text.integrityCheckAlgorithm",
"path": "Act.text.integrityCheckAlgorithm",
"representation": [
"xmlAttr"
],
"label": "Integrity Check Algorithm",
"definition": "Specifies the algorithm used to compute the integrityCheck value. The cryptographically strong checksum algorithm Secure Hash Algorithm-1 (SHA-1) is currently the industry standard. It has superseded the MD5 algorithm only a couple of years ago, when certain flaws in the security of MD5 were discovered. Currently the SHA-1 hash algorithm is the default choice for the integrity check algorithm. Note that SHA-256 is also entering widespread usage.",
"min": 0,
"max": "1",
"base": {
"path": "ED.integrityCheckAlgorithm",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0"
}
},
{
"id": "Act.text.language",
"path": "Act.text.language",
"representation": [
"xmlAttr"
],
"label": "Language",
"definition": "For character based information the language property specifies the human language of the text.",
"min": 0,
"max": "1",
"base": {
"path": "ED.language",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.text.mediaType",
"path": "Act.text.mediaType",
"representation": [
"xmlAttr"
],
"label": "Media Type",
"definition": "Identifies the type of the encapsulated data and identifies a method to interpret or render the data.",
"min": 0,
"max": "1",
"base": {
"path": "ED.mediaType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType|3.0.0"
}
},
{
"id": "Act.text.representation",
"path": "Act.text.representation",
"representation": [
"xmlAttr"
],
"min": 0,
"max": "1",
"base": {
"path": "ED.representation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding|2.0.3-sd"
}
},
{
"id": "Act.text.xmlText",
"path": "Act.text.xmlText",
"representation": [
"xmlText"
],
"short": "Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string.",
"definition": "Data that is primarily intended for human interpretation or for further machine processing is outside the scope of HL7. This includes unformatted or formatted written language, multimedia data, or structured information as defined by a different standard (e.g., XML-signatures.)",
"comment": "This element is represented in XML as textual content. The actual name \"xmlText\" will not appear in a CDA instance.",
"min": 0,
"max": "1",
"base": {
"path": "ED.xmlText",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/st-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.text.reference",
"path": "Act.text.reference",
"label": "Reference",
"definition": "A telecommunication address (TEL), such as a URL for HTTP or FTP, which will resolve to precisely the same binary data that could as well have been provided as inline data.",
"min": 0,
"max": "1",
"base": {
"path": "ED.reference",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL"
}
],
"constraint": [
{
"key": "value-starts-octothorpe",
"severity": "error",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"expression": "value.exists() implies value.startsWith('#')",
"source": "http://hl7.org/cda/us/ccda/StructureDefinition/EntryReference"
}
]
},
{
"id": "Act.text.thumbnail",
"path": "Act.text.thumbnail",
"label": "Thumbnail",
"definition": "An abbreviated rendition of the full data. A thumbnail requires significantly fewer resources than the full data, while still maintaining some distinctive similarity with the full data. A thumbnail is typically used with by-reference encapsulated data. It allows a user to select data more efficiently before actually downloading through the reference.",
"min": 0,
"max": "1",
"base": {
"path": "ED.thumbnail",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ED"
}
],
"constraint": [
{
"key": "ED-1",
"severity": "error",
"human": "Thumbnails cannot contain their own thumbnails",
"expression": "thumbnail.empty()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/Act|2.0.3-sd"
}
]
},
{
"id": "Act.statusCode",
"path": "Act.statusCode",
"comment": "SHALL contain exactly one [1..1] statusCode (CONF:1098-31498).",
"min": 1,
"max": "1",
"base": {
"path": "Act.statusCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActStatus|3.0.0"
}
},
{
"id": "Act.statusCode.nullFlavor",
"path": "Act.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.statusCode.code",
"path": "Act.statusCode.code",
"representation": [
"xmlAttr"
],
"label": "Code",
"short": "MAY be set to \"completed\"",
"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": "This statusCode MAY contain zero or one [0..1] @code=\"completed\" (CodeSystem: HL7ActStatus urn:oid:2.16.840.1.113883.5.14) (CONF:1098-31499).",
"min": 0,
"max": "1",
"base": {
"path": "CD.code",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
]
},
{
"id": "Act.statusCode.codeSystem",
"path": "Act.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|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
]
},
{
"id": "Act.statusCode.codeSystemName",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.statusCode.codeSystemVersion",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.statusCode.displayName",
"path": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.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": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.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": "Act.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.statusCode.originalText",
"path": "Act.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": "Act.statusCode.qualifier",
"path": "Act.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": "Act.statusCode.translation",
"path": "Act.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"
}
]
},
{
"id": "Act.effectiveTime",
"path": "Act.effectiveTime",
"min": 0,
"max": "1",
"base": {
"path": "Act.effectiveTime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS"
}
]
},
{
"id": "Act.priorityCode",
"path": "Act.priorityCode",
"min": 0,
"max": "1",
"base": {
"path": "Act.priorityCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CE"
}
],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-ActPriority|3.0.0"
}
},
{
"id": "Act.languageCode",
"path": "Act.languageCode",
"min": 0,
"max": "1",
"base": {
"path": "Act.languageCode",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/CS"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/all-languages"
}
},
{
"id": "Act.subject",
"path": "Act.subject",
"min": 0,
"max": "1",
"base": {
"path": "Act.subject",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject"
}
]
},
{
"id": "Act.specimen",
"path": "Act.specimen",
"min": 0,
"max": "*",
"base": {
"path": "Act.specimen",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen"
}
]
},
{
"id": "Act.performer",
"path": "Act.performer",
"min": 0,
"max": "*",
"base": {
"path": "Act.performer",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2"
}
]
},
{
"id": "Act.author",
"path": "Act.author",
"min": 0,
"max": "*",
"base": {
"path": "Act.author",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Author"
}
]
},
{
"id": "Act.informant",
"path": "Act.informant",
"min": 0,
"max": "*",
"base": {
"path": "Act.informant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant"
}
]
},
{
"id": "Act.participant",
"path": "Act.participant",
"min": 0,
"max": "*",
"base": {
"path": "Act.participant",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2"
}
]
},
{
"id": "Act.entryRelationship",
"path": "Act.entryRelationship",
"min": 0,
"max": "*",
"base": {
"path": "Act.entryRelationship",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship"
}
]
},
{
"id": "Act.reference",
"path": "Act.reference",
"comment": "MUST contain exactly one [1..1] reference.",
"min": 1,
"max": "1",
"base": {
"path": "Act.reference",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference"
}
]
},
{
"id": "Act.reference.nullFlavor",
"path": "Act.reference.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.reference.realmCode",
"path": "Act.reference.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": "Act.reference.typeId",
"path": "Act.reference.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"
}
],
"constraint": [
{
"key": "II-1",
"severity": "error",
"human": "An II instance must have either a root or an nullFlavor.",
"expression": "root.exists() or nullFlavor.exists()",
"source": "http://hl7.org/cda/stds/core/StructureDefinition/InfrastructureRoot|2.0.3-sd"
}
]
},
{
"id": "Act.reference.typeId.nullFlavor",
"path": "Act.reference.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|2.0.3-sd"
]
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor|2.0.3-sd"
}
},
{
"id": "Act.reference.typeId.assigningAuthorityName",
"path": "Act.reference.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.reference.typeId.displayable",
"path": "Act.reference.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.reference.typeId.root",
"path": "Act.reference.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|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/uuid|2.0.3-sd",
"http://hl7.org/cda/stds/core/StructureDefinition/ruid|2.0.3-sd"
]
}
],
"fixedString": "2.16.840.1.113883.1.3"
},
{
"id": "Act.reference.typeId.extension",
"path": "Act.reference.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|2.0.3-sd"
]
}
]
},
{
"id": "Act.reference.templateId",
"path": "Act.reference.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": "Act.reference.typeCode",
"path": "Act.reference.typeCode",
"representation": [
"xmlAttr"
],
"comment": "MUST contain exactly one [1..1] @typeCode=\"REFR\" Reference (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1198-9026).",
"min": 1,
"max": "1",
"base": {
"path": "Reference.typeCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code",
"profile": [
"http://hl7.org/cda/stds/core/StructureDefinition/cs-simple|2.0.3-sd"
]
}
],
"fixedCode": "REFR",
"binding": {
"strength": "required",
"valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipExternalReference|3.0.0"
}
},
{
"id": "Act.reference.seperatableInd",
"path": "Act.reference.seperatableInd",
"min": 0,
"max": "1",
"base": {
"path": "Reference.seperatableInd",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/BL"
}
]
},
{
"id": "Act.reference.externalAct",
"path": "Act.reference.externalAct",
"comment": "Use externalAct to reference any other FHIR Entry Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.externalAct",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalAct"
}
]
},
{
"id": "Act.reference.externalObservation",
"path": "Act.reference.externalObservation",
"comment": "Use externalObservation to reference any FHIR Entry Observation Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.externalObservation",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalObservation"
}
]
},
{
"id": "Act.reference.externalProcedure",
"path": "Act.reference.externalProcedure",
"comment": "Use externalProcedure to reference any FHIR Entry Procedure Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.externalProcedure",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalProcedure"
}
]
},
{
"id": "Act.reference.externalDocument",
"path": "Act.reference.externalDocument",
"comment": "Use externalDocument to reference any FHIR DocumentReference EntryResource or Composition Entry Resource.",
"min": 0,
"max": "1",
"base": {
"path": "Reference.externalDocument",
"min": 0,
"max": "1"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/ExternalDocument"
}
]
},
{
"id": "Act.precondition",
"path": "Act.precondition",
"min": 0,
"max": "*",
"base": {
"path": "Act.precondition",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition"
}
]
},
{
"id": "Act.sdtcPrecondition2",
"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": "precondition2"
}
],
"path": "Act.sdtcPrecondition2",
"min": 0,
"max": "*",
"base": {
"path": "Act.sdtcPrecondition2",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2"
}
]
},
{
"id": "Act.sdtcInFulfillmentOf1",
"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": "inFulfillmentOf1"
}
],
"path": "Act.sdtcInFulfillmentOf1",
"min": 0,
"max": "*",
"base": {
"path": "Act.sdtcInFulfillmentOf1",
"min": 0,
"max": "*"
},
"type": [
{
"code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Act",
"path": "Act",
"constraint": [
{
"key": "should-text-ref-value",
"severity": "warning",
"human": "SHOULD contain text/reference/@value",
"expression": "text.reference.value.exists()",
"source": "http://hl7.org/cda/us/adi/StructureDefinition/External.Entry.Reference.Entry"
}
]
},
{
"id": "Act.templateId",
"path": "Act.templateId",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "root"
},
{
"type": "value",
"path": "extension"
}
],
"rules": "open"
},
"min": 2
},
{
"id": "Act.templateId:external-entry-reference",
"path": "Act.templateId",
"sliceName": "external-entry-reference",
"min": 1,
"max": "1"
},
{
"id": "Act.templateId:external-entry-reference.root",
"path": "Act.templateId.root",
"min": 1,
"patternString": "2.16.840.1.113883.4.823.1.4.2.5"
},
{
"id": "Act.templateId:external-entry-reference.extension",
"path": "Act.templateId.extension",
"min": 1,
"patternString": "2026-08-28"
},
{
"id": "Act.id",
"path": "Act.id",
"short": "When using a FHIR Collection Bundle for the entries, use the Resource name/Resource id as the id value. For example, \nif the entry is a FHIR Patient resource with id 123, then the id value would be 'Condition/123'.",
"comment": "MUST contain at least one [1..*] id."
},
{
"id": "Act.text",
"path": "Act.text",
"short": "links to the rendering of the entry information contained in the externally referenced Resource."
},
{
"id": "Act.text.reference",
"path": "Act.text.reference",
"constraint": [
{
"key": "value-starts-octothorpe",
"severity": "error",
"human": "If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative",
"expression": "value.exists() implies value.startsWith('#')",
"source": "http://hl7.org/cda/us/adi/StructureDefinition/External.Entry.Reference.Entry"
}
]
},
{
"id": "Act.reference",
"path": "Act.reference",
"comment": "MUST contain exactly one [1..1] reference.",
"min": 1,
"max": "1"
},
{
"id": "Act.reference.typeCode",
"path": "Act.reference.typeCode",
"comment": "MUST contain exactly one [1..1] @typeCode=\"REFR\" Reference (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.110 STATIC) (CONF:1198-9026).",
"fixedCode": "REFR"
},
{
"id": "Act.reference.externalAct",
"path": "Act.reference.externalAct",
"comment": "Use externalAct to reference any other FHIR Entry Resource."
},
{
"id": "Act.reference.externalObservation",
"path": "Act.reference.externalObservation",
"comment": "Use externalObservation to reference any FHIR Entry Observation Resource."
},
{
"id": "Act.reference.externalProcedure",
"path": "Act.reference.externalProcedure",
"comment": "Use externalProcedure to reference any FHIR Entry Procedure Resource."
},
{
"id": "Act.reference.externalDocument",
"path": "Act.reference.externalDocument",
"comment": "Use externalDocument to reference any FHIR DocumentReference EntryResource or Composition Entry Resource."
}
]
}
}