Package | hl7.cda.us.ccda |
Type | StructureDefinition |
Id | EncounterActivity |
FHIR Version | R5 |
Source | http://hl7.org/cda/us/ccda/https://build.fhir.org/ig/HL7/CDA-ccda/StructureDefinition-EncounterActivity.html |
URL | http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity |
Version | 4.0.0 |
Status | draft |
Date | 2025-06-26T21:09:45+00:00 |
Name | EncounterActivity |
Title | Encounter Activity |
Realm | us |
Authority | hl7 |
Description | This clinical statement describes an interaction between a patient and clinician. Interactions may include in-person encounters, telephone conversations, and email exchanges. #### Templates Used Although open templates may contain any valid CDA content, the following templates are specifically called out by this template: **Optional EntryRelationships**: [EncounterDiagnosis](StructureDefinition-EncounterDiagnosis.html), [Indication](StructureDefinition-Indication.html), [InterpreterNeededObservation](StructureDefinition-InterpreterNeededObservation.html) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
Kind | logical |
StructureDefinition | |
EncountersSection | Encounters Section |
InterventionAct | Intervention Act |
StructureDefinition | |
Act | Act (CDA Class) |
Encounter | Encounter (CDA Class) |
Observation | Observation (CDA Class) |
ParticipantRole | ParticipantRole (CDA Class) |
EncounterDiagnosis | Encounter Diagnosis |
Indication | Indication |
InterpreterNeededObservation | Interpreter Needed Observation |
ServiceDeliveryLocation | Service Delivery Location |
ValueSet | |
v3-USEncounterDischargeDisposition | USEncounterDischargeDisposition |
v3-USEncounterDischargeDisposition | USEncounterDischargeDisposition |
2.16.840.1.113762.1.4.1267.23 | Encounter Type |
2.16.840.1.114222.4.11.1066 | Healthcare Provider Taxonomy |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition EncounterActivity
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
![]() ![]() | C | 1..1 | Encounter | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, text, statusCode, effectiveTime, sdtcDischargeDispositionCode, priorityCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Constraints: should-text-ref-value |
![]() ![]() ![]() | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
![]() ![]() ![]() ![]() | 1..1 | II | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.49 | |
![]() ![]() ![]() ![]() ![]() | 1..1 | st | Required Pattern: 2015-08-01 | |
![]() ![]() ![]() | 1..1 | cs | ||
![]() ![]() ![]() | 1..1 | cs | Fixed Value: EVN | |
![]() ![]() ![]() | 1..* | II | 𝗨𝗦𝗖𝗗𝗜: Identifier | |
![]() ![]() ![]() | C | 1..1 | CD | 𝗨𝗦𝗖𝗗𝗜: Type Binding: Encounter Type ![]() Constraints: should-otext-ref-value |
![]() ![]() ![]() ![]() | 0..1 | ED | SHOULD reference the portion of narrative corresponding to this code | |
![]() ![]() ![]() ![]() ![]() | C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() | 0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |
![]() ![]() ![]() ![]() | C | 0..1 | TEL | Constraints: value-starts-octothorpe |
![]() ![]() ![]() | 1..1 | IVL_TS | 𝗨𝗦𝗖𝗗𝗜: Time | |
![]() ![]() ![]() | 0..1 | CE | XML Namespace: urn:hl7-org:sdtc 𝗨𝗦𝗖𝗗𝗜: Disposition XML: dischargeDispositionCode (urn:hl7-org:sdtc) Binding: USEncounterDischargeDisposition (preferred) | |
![]() ![]() ![]() | 0..* | Performer2 | ||
![]() ![]() ![]() ![]() | 1..1 | AssignedEntity | ||
![]() ![]() ![]() ![]() ![]() | 0..1 | CE | Binding: Healthcare Provider Taxonomy ![]() | |
![]() ![]() ![]() | 0..* | Participant2 | Slice: Unordered, Open by profile:participantRole, value:typeCode | |
![]() ![]() ![]() ![]() | 0..* | Participant2 | 𝗨𝗦𝗖𝗗𝗜: Location | |
![]() ![]() ![]() ![]() ![]() | 1..1 | cs | Fixed Value: LOC | |
![]() ![]() ![]() ![]() ![]() | 1..1 | ServiceDeliveryLocation | ||
![]() ![]() ![]() | 0..* | EntryRelationship | Slice: Unordered, Open by profile:act, profile:observation | |
![]() ![]() ![]() ![]() | 0..* | EntryRelationship | ||
![]() ![]() ![]() ![]() ![]() | 1..1 | cs | Fixed Value: RSON | |
![]() ![]() ![]() ![]() ![]() | 1..1 | Indication | ||
![]() ![]() ![]() ![]() | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Diagnosis | |
![]() ![]() ![]() ![]() ![]() | 1..1 | EncounterDiagnosis | ||
![]() ![]() ![]() ![]() | 0..* | EntryRelationship | 𝗨𝗦𝗖𝗗𝗜: Interpreter Needed Observation | |
![]() ![]() ![]() ![]() ![]() | 1..1 | InterpreterNeededObservation | ||
{ "resourceType": "StructureDefinition", "id": "EncounterActivity", "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/xml-namespace", "valueUri": "urn:hl7-org:v3" }, { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-name", "valueString": "encounter" }, { "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", "valueCode": "cda" } ], "url": "http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity", "identifier": [ { "system": "urn:ietf:rfc:3986", "value": "urn:hl7ii:2.16.840.1.113883.10.20.22.4.49:2015-08-01" } ], "version": "4.0.0", "name": "EncounterActivity", "title": "Encounter Activity", "status": "draft", "date": "2025-06-26T21:09:45+00:00", "publisher": "Health Level Seven", "contact": [ { "name": "HL7 International - Structured Documents", "telecom": [ { "system": "url", "value": "http://www.hl7.org/Special/committees/structure" } ] } ], "description": "This clinical statement describes an interaction between a patient and clinician. Interactions may include in-person encounters, telephone conversations, and email exchanges.\n\n#### Templates Used\nAlthough open templates may contain any valid CDA content, the following templates are specifically called out by this template:\n\n**Optional EntryRelationships**: [EncounterDiagnosis](StructureDefinition-EncounterDiagnosis.html), [Indication](StructureDefinition-Indication.html), [InterpreterNeededObservation](StructureDefinition-InterpreterNeededObservation.html)", "jurisdiction": [ { "coding": [ { "system": "urn:iso:std:iso:3166", "code": "US" } ] } ], "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/Encounter", "baseDefinition": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter", "derivation": "constraint", "snapshot": { "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version", "valueString": "2.0.1-sd" } ], "element": [ { "id": "Encounter", "path": "Encounter", "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/EncounterActivity" } ], "isModifier": false, "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "id": "Encounter.nullFlavor", "path": "Encounter.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": "Encounter.realmCode", "path": "Encounter.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": "Encounter.typeId", "path": "Encounter.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" } ] }, { "id": "Encounter.typeId.nullFlavor", "path": "Encounter.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": "Encounter.typeId.assigningAuthorityName", "path": "Encounter.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": "Encounter.typeId.displayable", "path": "Encounter.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": "Encounter.typeId.root", "path": "Encounter.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": "Encounter.typeId.extension", "path": "Encounter.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": "Encounter.templateId", "path": "Encounter.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": 1, "max": "*", "base": { "path": "InfrastructureRoot.templateId", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Encounter.templateId:encounter-activity", "path": "Encounter.templateId", "sliceName": "encounter-activity", "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": "Encounter.templateId:encounter-activity.nullFlavor", "path": "Encounter.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Encounter.templateId:encounter-activity.assigningAuthorityName", "path": "Encounter.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" ] } ] }, { "id": "Encounter.templateId:encounter-activity.displayable", "path": "Encounter.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" ] } ] }, { "id": "Encounter.templateId:encounter-activity.root", "path": "Encounter.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", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ] } ], "patternString": "2.16.840.1.113883.10.20.22.4.49" }, { "id": "Encounter.templateId:encounter-activity.extension", "path": "Encounter.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" ] } ], "patternString": "2015-08-01" }, { "id": "Encounter.classCode", "path": "Encounter.classCode", "representation": [ "xmlAttr" ], "comment": "SHALL contain exactly one [1..1] @classCode=\"ENC\" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8710).", "min": 1, "max": "1", "base": { "path": "Encounter.classCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "ENC", "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAActClass" } }, { "id": "Encounter.moodCode", "path": "Encounter.moodCode", "representation": [ "xmlAttr" ], "comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8711).", "min": 1, "max": "1", "base": { "path": "Encounter.moodCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "EVN", "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-xDocumentEncounterMood|2.0.0" } }, { "id": "Encounter.id", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.id", "short": "π¨π¦πππ: Identifier", "comment": "SHALL contain at least one [1..*] id (CONF:1198-8713).", "min": 1, "max": "*", "base": { "path": "Encounter.id", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Encounter.code", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.code", "short": "π¨π¦πππ: Type", "comment": "In Encounter Summaries the Encounter Type will also be present in the document header at componentOf/encompassingEncounter/code, but for Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present. Implementers should note that only conveying Encounter Type in the document header at componentOf/encompassingEncounter/code is insufficient.", "min": 1, "max": "1", "base": { "path": "Encounter.code", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CD" } ], "constraint": [ { "key": "should-otext-ref-value", "severity": "warning", "human": "SHOULD contain originalText/reference/@value", "expression": "originalText.reference.value.exists()", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity" } ], "binding": { "strength": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23" } }, { "id": "Encounter.code.nullFlavor", "path": "Encounter.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.", "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": "Encounter.code.code", "path": "Encounter.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" ] } ] }, { "id": "Encounter.code.codeSystem", "path": "Encounter.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", "http://hl7.org/cda/stds/core/StructureDefinition/uuid", "http://hl7.org/cda/stds/core/StructureDefinition/ruid" ] } ] }, { "id": "Encounter.code.codeSystemName", "path": "Encounter.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" ] } ] }, { "id": "Encounter.code.codeSystemVersion", "path": "Encounter.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" ] } ] }, { "id": "Encounter.code.displayName", "path": "Encounter.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" ] } ] }, { "id": "Encounter.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": "Encounter.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" ] } ] }, { "id": "Encounter.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": "Encounter.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" ] } ] }, { "id": "Encounter.code.originalText", "path": "Encounter.code.originalText", "label": "Original Text", "short": "SHOULD reference the portion of narrative corresponding to this code", "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": "Encounter.code.originalText.nullFlavor", "path": "Encounter.code.originalText.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": "Encounter.code.originalText.compression", "path": "Encounter.code.originalText.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm" } }, { "id": "Encounter.code.originalText.integrityCheck", "path": "Encounter.code.originalText.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" ] } ] }, { "id": "Encounter.code.originalText.integrityCheckAlgorithm", "path": "Encounter.code.originalText.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" ] } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0" } }, { "id": "Encounter.code.originalText.language", "path": "Encounter.code.originalText.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" ] } ] }, { "id": "Encounter.code.originalText.mediaType", "path": "Encounter.code.originalText.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" ] } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType" } }, { "id": "Encounter.code.originalText.representation", "path": "Encounter.code.originalText.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding" } }, { "id": "Encounter.code.originalText.xmlText", "path": "Encounter.code.originalText.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" ] } ] }, { "id": "Encounter.code.originalText.reference", "path": "Encounter.code.originalText.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/EncounterActivity" } ] }, { "id": "Encounter.code.originalText.thumbnail", "path": "Encounter.code.originalText.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" } ] }, { "id": "Encounter.code.qualifier", "path": "Encounter.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": "Encounter.code.translation", "path": "Encounter.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": "Encounter.text", "path": "Encounter.text", "short": "SHOULD reference the portion of section narrative text corresponding to this entry", "min": 0, "max": "1", "base": { "path": "Encounter.text", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ED" } ] }, { "id": "Encounter.text.nullFlavor", "path": "Encounter.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor" } }, { "id": "Encounter.text.compression", "path": "Encounter.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm" } }, { "id": "Encounter.text.integrityCheck", "path": "Encounter.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" ] } ] }, { "id": "Encounter.text.integrityCheckAlgorithm", "path": "Encounter.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" ] } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0" } }, { "id": "Encounter.text.language", "path": "Encounter.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" ] } ] }, { "id": "Encounter.text.mediaType", "path": "Encounter.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" ] } ], "binding": { "strength": "example", "valueSet": "http://terminology.hl7.org/ValueSet/v3-MediaType" } }, { "id": "Encounter.text.representation", "path": "Encounter.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" ] } ], "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding" } }, { "id": "Encounter.text.xmlText", "path": "Encounter.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" ] } ] }, { "id": "Encounter.text.reference", "path": "Encounter.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/EncounterActivity" } ] }, { "id": "Encounter.text.thumbnail", "path": "Encounter.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" } ] }, { "id": "Encounter.statusCode", "path": "Encounter.statusCode", "min": 0, "max": "1", "base": { "path": "Encounter.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" } }, { "id": "Encounter.effectiveTime", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.effectiveTime", "short": "π¨π¦πππ: Time", "comment": "In Encounter Summaries the Encounter Time will also be present in the document header at componentOf/encompassingEncounter/effectiveTime, but for Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present.", "min": 1, "max": "1", "base": { "path": "Encounter.effectiveTime", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" } ] }, { "id": "Encounter.sdtcDischargeDispositionCode", "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": "dischargeDispositionCode" }, { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.sdtcDischargeDispositionCode", "short": "π¨π¦πππ: Disposition", "comment": "Implementers should note that a Discharge Disposition is not appropriate for all document types. Hospital Discharge Summary documents SHOULD have a discharge disposition. Progress Notes, or H&P, typically wonβt have a discharge disposition. In Encounter Summaries, the Encounter Disposition will also be present in the document header at componentOf/encompassingEncounter/dischargeDispositionCode, but in Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present. While an Encounter Summary provides a snapshot of the patientβs condition at the time of the encounter as authored by the clinician, a Patient summary provides the most current information available from the sending system across multiple encounters. [CodeSystem-AHANUBCPatientDischargeStatus](https://terminology.hl7.org/CodeSystem-AHANUBCPatientDischargeStatus.html)", "min": 0, "max": "1", "base": { "path": "Encounter.sdtcDischargeDispositionCode", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "preferred", "valueSet": "http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition" } }, { "id": "Encounter.priorityCode", "path": "Encounter.priorityCode", "min": 0, "max": "1", "base": { "path": "Encounter.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" } }, { "id": "Encounter.subject", "path": "Encounter.subject", "min": 0, "max": "1", "base": { "path": "Encounter.subject", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Subject" } ] }, { "id": "Encounter.specimen", "path": "Encounter.specimen", "min": 0, "max": "*", "base": { "path": "Encounter.specimen", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Specimen" } ] }, { "id": "Encounter.performer", "path": "Encounter.performer", "comment": "MAY contain zero or more [0..*] performer (CONF:1198-8725).", "min": 0, "max": "*", "base": { "path": "Encounter.performer", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Performer2" } ] }, { "id": "Encounter.performer.nullFlavor", "path": "Encounter.performer.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": "Encounter.performer.realmCode", "path": "Encounter.performer.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": "Encounter.performer.typeId", "path": "Encounter.performer.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" } ] }, { "id": "Encounter.performer.typeId.nullFlavor", "path": "Encounter.performer.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": "Encounter.performer.typeId.assigningAuthorityName", "path": "Encounter.performer.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": "Encounter.performer.typeId.displayable", "path": "Encounter.performer.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": "Encounter.performer.typeId.root", "path": "Encounter.performer.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": "Encounter.performer.typeId.extension", "path": "Encounter.performer.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": "Encounter.performer.templateId", "path": "Encounter.performer.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": "Encounter.performer.typeCode", "path": "Encounter.performer.typeCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "Performer2.typeCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "PRF", "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-ParticipationPhysicalPerformer" } }, { "id": "Encounter.performer.sdtcFunctionCode", "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": "functionCode" } ], "path": "Encounter.performer.sdtcFunctionCode", "min": 0, "max": "1", "base": { "path": "Performer2.sdtcFunctionCode", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ] }, { "id": "Encounter.performer.time", "path": "Encounter.performer.time", "min": 0, "max": "1", "base": { "path": "Performer2.time", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" } ] }, { "id": "Encounter.performer.modeCode", "path": "Encounter.performer.modeCode", "min": 0, "max": "1", "base": { "path": "Performer2.modeCode", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ] }, { "id": "Encounter.performer.assignedEntity", "path": "Encounter.performer.assignedEntity", "comment": "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8726).", "min": 1, "max": "1", "base": { "path": "Performer2.assignedEntity", "min": 1, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/AssignedEntity" } ] }, { "id": "Encounter.performer.assignedEntity.nullFlavor", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.realmCode", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.typeId", "path": "Encounter.performer.assignedEntity.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" } ] }, { "id": "Encounter.performer.assignedEntity.typeId.nullFlavor", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.typeId.assigningAuthorityName", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.typeId.displayable", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.typeId.root", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.typeId.extension", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.templateId", "path": "Encounter.performer.assignedEntity.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": "Encounter.performer.assignedEntity.classCode", "path": "Encounter.performer.assignedEntity.classCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "AssignedEntity.classCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "ASSIGNED", "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity" } }, { "id": "Encounter.performer.assignedEntity.id", "path": "Encounter.performer.assignedEntity.id", "min": 1, "max": "*", "base": { "path": "AssignedEntity.id", "min": 1, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Encounter.performer.assignedEntity.sdtcIdentifiedBy", "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": "identifiedBy" } ], "path": "Encounter.performer.assignedEntity.sdtcIdentifiedBy", "min": 0, "max": "*", "base": { "path": "AssignedEntity.sdtcIdentifiedBy", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy" } ] }, { "id": "Encounter.performer.assignedEntity.code", "path": "Encounter.performer.assignedEntity.code", "comment": "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-8727).", "min": 0, "max": "1", "base": { "path": "AssignedEntity.code", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ], "binding": { "strength": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066" } }, { "id": "Encounter.performer.assignedEntity.addr", "path": "Encounter.performer.assignedEntity.addr", "min": 0, "max": "*", "base": { "path": "AssignedEntity.addr", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/AD" } ] }, { "id": "Encounter.performer.assignedEntity.telecom", "path": "Encounter.performer.assignedEntity.telecom", "min": 0, "max": "*", "base": { "path": "AssignedEntity.telecom", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/TEL" } ] }, { "id": "Encounter.performer.assignedEntity.assignedPerson", "path": "Encounter.performer.assignedEntity.assignedPerson", "min": 0, "max": "1", "base": { "path": "AssignedEntity.assignedPerson", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Person" } ] }, { "id": "Encounter.performer.assignedEntity.representedOrganization", "path": "Encounter.performer.assignedEntity.representedOrganization", "min": 0, "max": "1", "base": { "path": "AssignedEntity.representedOrganization", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organization" } ] }, { "id": "Encounter.performer.assignedEntity.sdtcPatient", "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": "patient" } ], "path": "Encounter.performer.assignedEntity.sdtcPatient", "min": 0, "max": "1", "base": { "path": "AssignedEntity.sdtcPatient", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/fhir/StructureDefinition/Base" } ] }, { "id": "Encounter.performer.assignedEntity.sdtcPatient.id", "extension": [ { "url": "http://hl7.org/fhir/tools/StructureDefinition/xml-namespace", "valueUri": "urn:hl7-org:sdtc" } ], "path": "Encounter.performer.assignedEntity.sdtcPatient.id", "min": 1, "max": "1", "base": { "path": "AssignedEntity.sdtcPatient.id", "min": 1, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/II" } ] }, { "id": "Encounter.author", "path": "Encounter.author", "min": 0, "max": "*", "base": { "path": "Encounter.author", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Author" } ] }, { "id": "Encounter.informant", "path": "Encounter.informant", "min": 0, "max": "*", "base": { "path": "Encounter.informant", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Informant" } ] }, { "id": "Encounter.participant", "path": "Encounter.participant", "slicing": { "discriminator": [ { "type": "profile", "path": "participantRole" }, { "type": "value", "path": "typeCode" } ], "rules": "open" }, "min": 0, "max": "*", "base": { "path": "Encounter.participant", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2" } ] }, { "id": "Encounter.participant:location", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.participant", "sliceName": "location", "short": "π¨π¦πππ: Location", "comment": "In Encounter Summaries the Encounter Location will also be present in the document header at componentOf/encompassingEncounter/location, but in Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present.", "min": 0, "max": "*", "base": { "path": "Encounter.participant", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Participant2" } ] }, { "id": "Encounter.participant:location.nullFlavor", "path": "Encounter.participant.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": "Encounter.participant:location.realmCode", "path": "Encounter.participant.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": "Encounter.participant:location.typeId", "path": "Encounter.participant.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" } ] }, { "id": "Encounter.participant:location.typeId.nullFlavor", "path": "Encounter.participant.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": "Encounter.participant:location.typeId.assigningAuthorityName", "path": "Encounter.participant.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": "Encounter.participant:location.typeId.displayable", "path": "Encounter.participant.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": "Encounter.participant:location.typeId.root", "path": "Encounter.participant.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": "Encounter.participant:location.typeId.extension", "path": "Encounter.participant.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": "Encounter.participant:location.templateId", "path": "Encounter.participant.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": "Encounter.participant:location.typeCode", "path": "Encounter.participant.typeCode", "representation": [ "xmlAttr" ], "comment": "SHALL contain exactly one [1..1] @typeCode=\"LOC\" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8740).", "min": 1, "max": "1", "base": { "path": "Participant2.typeCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "LOC", "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType" } }, { "id": "Encounter.participant:location.contextControlCode", "path": "Encounter.participant.contextControlCode", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "Participant2.contextControlCode", "min": 0, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "OP", "binding": { "strength": "required", "valueSet": "http://hl7.org/cda/stds/core/ValueSet/CDAContextControl" } }, { "id": "Encounter.participant:location.sdtcFunctionCode", "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": "functionCode" } ], "path": "Encounter.participant.sdtcFunctionCode", "min": 0, "max": "1", "base": { "path": "Participant2.sdtcFunctionCode", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ] }, { "id": "Encounter.participant:location.time", "path": "Encounter.participant.time", "min": 0, "max": "1", "base": { "path": "Participant2.time", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS" } ] }, { "id": "Encounter.participant:location.awarenessCode", "path": "Encounter.participant.awarenessCode", "min": 0, "max": "1", "base": { "path": "Participant2.awarenessCode", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/CE" } ] }, { "id": "Encounter.participant:location.participantRole", "path": "Encounter.participant.participantRole", "comment": "SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1198-14903).", "min": 1, "max": "1", "base": { "path": "Participant2.participantRole", "min": 1, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ServiceDeliveryLocation" ] } ] }, { "id": "Encounter.entryRelationship", "path": "Encounter.entryRelationship", "slicing": { "discriminator": [ { "type": "profile", "path": "act" }, { "type": "profile", "path": "observation" } ], "rules": "open" }, "min": 0, "max": "*", "base": { "path": "Encounter.entryRelationship", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship" } ] }, { "id": "Encounter.entryRelationship:indication", "path": "Encounter.entryRelationship", "sliceName": "indication", "comment": "MAY contain zero or more [0..*] entryRelationship (CONF:1198-8722) such that it", "min": 0, "max": "*", "base": { "path": "Encounter.entryRelationship", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship" } ] }, { "id": "Encounter.entryRelationship:indication.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.realmCode", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeId", "path": "Encounter.entryRelationship.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" } ] }, { "id": "Encounter.entryRelationship:indication.typeId.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeId.assigningAuthorityName", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeId.displayable", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeId.root", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeId.extension", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.templateId", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:indication.typeCode", "path": "Encounter.entryRelationship.typeCode", "representation": [ "xmlAttr" ], "comment": "SHALL contain exactly one [1..1] @typeCode=\"RSON\" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8723).", "min": 1, "max": "1", "base": { "path": "EntryRelationship.typeCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "fixedCode": "RSON", "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship" } }, { "id": "Encounter.entryRelationship:indication.inversionInd", "path": "Encounter.entryRelationship.inversionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.inversionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:indication.contextConductionInd", "path": "Encounter.entryRelationship.contextConductionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.contextConductionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "defaultValueBoolean": true }, { "id": "Encounter.entryRelationship:indication.negationInd", "path": "Encounter.entryRelationship.negationInd", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "EntryRelationship.negationInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:indication.sequenceNumber", "path": "Encounter.entryRelationship.sequenceNumber", "min": 0, "max": "1", "base": { "path": "EntryRelationship.sequenceNumber", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" } ] }, { "id": "Encounter.entryRelationship:indication.seperatableInd", "path": "Encounter.entryRelationship.seperatableInd", "min": 0, "max": "1", "base": { "path": "EntryRelationship.seperatableInd", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" } ] }, { "id": "Encounter.entryRelationship:indication.act", "path": "Encounter.entryRelationship.act", "min": 0, "max": "1", "base": { "path": "EntryRelationship.act", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Act" } ] }, { "id": "Encounter.entryRelationship:indication.encounter", "path": "Encounter.entryRelationship.encounter", "min": 0, "max": "1", "base": { "path": "EntryRelationship.encounter", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter" } ] }, { "id": "Encounter.entryRelationship:indication.observation", "path": "Encounter.entryRelationship.observation", "comment": "SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1198-14899).", "min": 1, "max": "1", "base": { "path": "EntryRelationship.observation", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/Indication" ] } ] }, { "id": "Encounter.entryRelationship:indication.observationMedia", "path": "Encounter.entryRelationship.observationMedia", "min": 0, "max": "1", "base": { "path": "EntryRelationship.observationMedia", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia" } ] }, { "id": "Encounter.entryRelationship:indication.organizer", "path": "Encounter.entryRelationship.organizer", "min": 0, "max": "1", "base": { "path": "EntryRelationship.organizer", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer" } ] }, { "id": "Encounter.entryRelationship:indication.procedure", "path": "Encounter.entryRelationship.procedure", "min": 0, "max": "1", "base": { "path": "EntryRelationship.procedure", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure" } ] }, { "id": "Encounter.entryRelationship:indication.regionOfInterest", "path": "Encounter.entryRelationship.regionOfInterest", "min": 0, "max": "1", "base": { "path": "EntryRelationship.regionOfInterest", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest" } ] }, { "id": "Encounter.entryRelationship:indication.substanceAdministration", "path": "Encounter.entryRelationship.substanceAdministration", "min": 0, "max": "1", "base": { "path": "EntryRelationship.substanceAdministration", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration" } ] }, { "id": "Encounter.entryRelationship:indication.supply", "path": "Encounter.entryRelationship.supply", "min": 0, "max": "1", "base": { "path": "EntryRelationship.supply", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply" } ] }, { "id": "Encounter.entryRelationship:diagnosis", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.entryRelationship", "sliceName": "diagnosis", "short": "π¨π¦πππ: Diagnosis", "comment": "MAY contain zero or more [0..*] entryRelationship (CONF:1198-15492) such that it", "min": 0, "max": "*", "base": { "path": "Encounter.entryRelationship", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship" } ] }, { "id": "Encounter.entryRelationship:diagnosis.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.realmCode", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeId", "path": "Encounter.entryRelationship.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" } ] }, { "id": "Encounter.entryRelationship:diagnosis.typeId.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeId.assigningAuthorityName", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeId.displayable", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeId.root", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeId.extension", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.templateId", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:diagnosis.typeCode", "path": "Encounter.entryRelationship.typeCode", "representation": [ "xmlAttr" ], "min": 1, "max": "1", "base": { "path": "EntryRelationship.typeCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship" } }, { "id": "Encounter.entryRelationship:diagnosis.inversionInd", "path": "Encounter.entryRelationship.inversionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.inversionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:diagnosis.contextConductionInd", "path": "Encounter.entryRelationship.contextConductionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.contextConductionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "defaultValueBoolean": true }, { "id": "Encounter.entryRelationship:diagnosis.negationInd", "path": "Encounter.entryRelationship.negationInd", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "EntryRelationship.negationInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:diagnosis.sequenceNumber", "path": "Encounter.entryRelationship.sequenceNumber", "min": 0, "max": "1", "base": { "path": "EntryRelationship.sequenceNumber", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" } ] }, { "id": "Encounter.entryRelationship:diagnosis.seperatableInd", "path": "Encounter.entryRelationship.seperatableInd", "min": 0, "max": "1", "base": { "path": "EntryRelationship.seperatableInd", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" } ] }, { "id": "Encounter.entryRelationship:diagnosis.act", "path": "Encounter.entryRelationship.act", "min": 1, "max": "1", "base": { "path": "EntryRelationship.act", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Act", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/EncounterDiagnosis" ] } ] }, { "id": "Encounter.entryRelationship:diagnosis.encounter", "path": "Encounter.entryRelationship.encounter", "min": 0, "max": "1", "base": { "path": "EntryRelationship.encounter", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter" } ] }, { "id": "Encounter.entryRelationship:diagnosis.observation", "path": "Encounter.entryRelationship.observation", "min": 0, "max": "1", "base": { "path": "EntryRelationship.observation", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation" } ] }, { "id": "Encounter.entryRelationship:diagnosis.observationMedia", "path": "Encounter.entryRelationship.observationMedia", "min": 0, "max": "1", "base": { "path": "EntryRelationship.observationMedia", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia" } ] }, { "id": "Encounter.entryRelationship:diagnosis.organizer", "path": "Encounter.entryRelationship.organizer", "min": 0, "max": "1", "base": { "path": "EntryRelationship.organizer", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer" } ] }, { "id": "Encounter.entryRelationship:diagnosis.procedure", "path": "Encounter.entryRelationship.procedure", "min": 0, "max": "1", "base": { "path": "EntryRelationship.procedure", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure" } ] }, { "id": "Encounter.entryRelationship:diagnosis.regionOfInterest", "path": "Encounter.entryRelationship.regionOfInterest", "min": 0, "max": "1", "base": { "path": "EntryRelationship.regionOfInterest", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest" } ] }, { "id": "Encounter.entryRelationship:diagnosis.substanceAdministration", "path": "Encounter.entryRelationship.substanceAdministration", "min": 0, "max": "1", "base": { "path": "EntryRelationship.substanceAdministration", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration" } ] }, { "id": "Encounter.entryRelationship:diagnosis.supply", "path": "Encounter.entryRelationship.supply", "min": 0, "max": "1", "base": { "path": "EntryRelationship.supply", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply" } ] }, { "id": "Encounter.entryRelationship:observation", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.entryRelationship", "sliceName": "observation", "short": "π¨π¦πππ: Interpreter Needed Observation", "comment": "SHALL contain exactly one [1..1] Interpreter Needed Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.515:2025-05-01).", "min": 0, "max": "*", "base": { "path": "Encounter.entryRelationship", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship" } ] }, { "id": "Encounter.entryRelationship:observation.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.realmCode", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeId", "path": "Encounter.entryRelationship.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" } ] }, { "id": "Encounter.entryRelationship:observation.typeId.nullFlavor", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeId.assigningAuthorityName", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeId.displayable", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeId.root", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeId.extension", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.templateId", "path": "Encounter.entryRelationship.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": "Encounter.entryRelationship:observation.typeCode", "path": "Encounter.entryRelationship.typeCode", "representation": [ "xmlAttr" ], "min": 1, "max": "1", "base": { "path": "EntryRelationship.typeCode", "min": 1, "max": "1" }, "type": [ { "code": "code", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/cs-simple" ] } ], "binding": { "strength": "required", "valueSet": "http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship" } }, { "id": "Encounter.entryRelationship:observation.inversionInd", "path": "Encounter.entryRelationship.inversionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.inversionInd can be set to \"true\" to indicate that the relationship should be interpreted as if the roles of the source and target entries were reversed.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.inversionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:observation.contextConductionInd", "path": "Encounter.entryRelationship.contextConductionInd", "representation": [ "xmlAttr" ], "definition": "The entryRelationship.contextConductionInd differs from the otherwise common use of this attribute in that in all other cases where this attribute is used, the value is fixed at \"true\", whereas here the value is defaulted to \"true\", and can be changed to \"false\" when referencing an entry in the same document. Setting the context conduction to false when referencing an entry in the same document keeps clear the fact that the referenced object retains its original context.", "min": 0, "max": "1", "base": { "path": "EntryRelationship.contextConductionInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ], "defaultValueBoolean": true }, { "id": "Encounter.entryRelationship:observation.negationInd", "path": "Encounter.entryRelationship.negationInd", "representation": [ "xmlAttr" ], "min": 0, "max": "1", "base": { "path": "EntryRelationship.negationInd", "min": 0, "max": "1" }, "type": [ { "code": "boolean", "profile": [ "http://hl7.org/cda/stds/core/StructureDefinition/bl-simple" ] } ] }, { "id": "Encounter.entryRelationship:observation.sequenceNumber", "path": "Encounter.entryRelationship.sequenceNumber", "min": 0, "max": "1", "base": { "path": "EntryRelationship.sequenceNumber", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/INT" } ] }, { "id": "Encounter.entryRelationship:observation.seperatableInd", "path": "Encounter.entryRelationship.seperatableInd", "min": 0, "max": "1", "base": { "path": "EntryRelationship.seperatableInd", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/BL" } ] }, { "id": "Encounter.entryRelationship:observation.act", "path": "Encounter.entryRelationship.act", "min": 0, "max": "1", "base": { "path": "EntryRelationship.act", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Act" } ] }, { "id": "Encounter.entryRelationship:observation.encounter", "path": "Encounter.entryRelationship.encounter", "min": 0, "max": "1", "base": { "path": "EntryRelationship.encounter", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Encounter" } ] }, { "id": "Encounter.entryRelationship:observation.observation", "path": "Encounter.entryRelationship.observation", "min": 1, "max": "1", "base": { "path": "EntryRelationship.observation", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/InterpreterNeededObservation" ] } ] }, { "id": "Encounter.entryRelationship:observation.observationMedia", "path": "Encounter.entryRelationship.observationMedia", "min": 0, "max": "1", "base": { "path": "EntryRelationship.observationMedia", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia" } ] }, { "id": "Encounter.entryRelationship:observation.organizer", "path": "Encounter.entryRelationship.organizer", "min": 0, "max": "1", "base": { "path": "EntryRelationship.organizer", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Organizer" } ] }, { "id": "Encounter.entryRelationship:observation.procedure", "path": "Encounter.entryRelationship.procedure", "min": 0, "max": "1", "base": { "path": "EntryRelationship.procedure", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Procedure" } ] }, { "id": "Encounter.entryRelationship:observation.regionOfInterest", "path": "Encounter.entryRelationship.regionOfInterest", "min": 0, "max": "1", "base": { "path": "EntryRelationship.regionOfInterest", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest" } ] }, { "id": "Encounter.entryRelationship:observation.substanceAdministration", "path": "Encounter.entryRelationship.substanceAdministration", "min": 0, "max": "1", "base": { "path": "EntryRelationship.substanceAdministration", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration" } ] }, { "id": "Encounter.entryRelationship:observation.supply", "path": "Encounter.entryRelationship.supply", "min": 0, "max": "1", "base": { "path": "EntryRelationship.supply", "min": 0, "max": "1" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Supply" } ] }, { "id": "Encounter.reference", "path": "Encounter.reference", "min": 0, "max": "*", "base": { "path": "Encounter.reference", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Reference" } ] }, { "id": "Encounter.precondition", "path": "Encounter.precondition", "min": 0, "max": "*", "base": { "path": "Encounter.precondition", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition" } ] }, { "id": "Encounter.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": "Encounter.sdtcPrecondition2", "min": 0, "max": "*", "base": { "path": "Encounter.sdtcPrecondition2", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Precondition2" } ] }, { "id": "Encounter.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": "Encounter.sdtcInFulfillmentOf1", "min": 0, "max": "*", "base": { "path": "Encounter.sdtcInFulfillmentOf1", "min": 0, "max": "*" }, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1" } ] } ] }, "differential": { "element": [ { "id": "Encounter", "path": "Encounter", "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/EncounterActivity" } ] }, { "id": "Encounter.templateId", "path": "Encounter.templateId", "slicing": { "discriminator": [ { "type": "value", "path": "root" }, { "type": "value", "path": "extension" } ], "rules": "open" }, "min": 1 }, { "id": "Encounter.templateId:encounter-activity", "path": "Encounter.templateId", "sliceName": "encounter-activity", "min": 1, "max": "1" }, { "id": "Encounter.templateId:encounter-activity.root", "path": "Encounter.templateId.root", "min": 1, "patternString": "2.16.840.1.113883.10.20.22.4.49" }, { "id": "Encounter.templateId:encounter-activity.extension", "path": "Encounter.templateId.extension", "min": 1, "patternString": "2015-08-01" }, { "id": "Encounter.classCode", "path": "Encounter.classCode", "comment": "SHALL contain exactly one [1..1] @classCode=\"ENC\" (CodeSystem: HL7ActClass urn:oid:2.16.840.1.113883.5.6 STATIC) (CONF:1198-8710)." }, { "id": "Encounter.moodCode", "path": "Encounter.moodCode", "comment": "SHALL contain exactly one [1..1] @moodCode=\"EVN\" (CodeSystem: HL7ActMood urn:oid:2.16.840.1.113883.5.1001 STATIC) (CONF:1198-8711).", "fixedCode": "EVN" }, { "id": "Encounter.id", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.id", "short": "π¨π¦πππ: Identifier", "comment": "SHALL contain at least one [1..*] id (CONF:1198-8713).", "min": 1 }, { "id": "Encounter.code", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.code", "short": "π¨π¦πππ: Type", "comment": "In Encounter Summaries the Encounter Type will also be present in the document header at componentOf/encompassingEncounter/code, but for Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present. Implementers should note that only conveying Encounter Type in the document header at componentOf/encompassingEncounter/code is insufficient.", "min": 1, "constraint": [ { "key": "should-otext-ref-value", "severity": "warning", "human": "SHOULD contain originalText/reference/@value", "expression": "originalText.reference.value.exists()", "source": "http://hl7.org/cda/us/ccda/StructureDefinition/EncounterActivity" } ], "binding": { "strength": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1267.23" } }, { "id": "Encounter.code.originalText", "path": "Encounter.code.originalText", "short": "SHOULD reference the portion of narrative corresponding to this code" }, { "id": "Encounter.code.originalText.reference", "path": "Encounter.code.originalText.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/ccda/StructureDefinition/EncounterActivity" } ] }, { "id": "Encounter.text", "path": "Encounter.text", "short": "SHOULD reference the portion of section narrative text corresponding to this entry" }, { "id": "Encounter.text.reference", "path": "Encounter.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/ccda/StructureDefinition/EncounterActivity" } ] }, { "id": "Encounter.effectiveTime", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.effectiveTime", "short": "π¨π¦πππ: Time", "comment": "In Encounter Summaries the Encounter Time will also be present in the document header at componentOf/encompassingEncounter/effectiveTime, but for Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present.", "min": 1 }, { "id": "Encounter.sdtcDischargeDispositionCode", "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": "dischargeDispositionCode" }, { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.sdtcDischargeDispositionCode", "short": "π¨π¦πππ: Disposition", "comment": "Implementers should note that a Discharge Disposition is not appropriate for all document types. Hospital Discharge Summary documents SHOULD have a discharge disposition. Progress Notes, or H&P, typically wonβt have a discharge disposition. In Encounter Summaries, the Encounter Disposition will also be present in the document header at componentOf/encompassingEncounter/dischargeDispositionCode, but in Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present. While an Encounter Summary provides a snapshot of the patientβs condition at the time of the encounter as authored by the clinician, a Patient summary provides the most current information available from the sending system across multiple encounters. [CodeSystem-AHANUBCPatientDischargeStatus](https://terminology.hl7.org/CodeSystem-AHANUBCPatientDischargeStatus.html)", "binding": { "strength": "preferred", "valueSet": "http://terminology.hl7.org/ValueSet/v3-USEncounterDischargeDisposition" } }, { "id": "Encounter.performer", "path": "Encounter.performer", "comment": "MAY contain zero or more [0..*] performer (CONF:1198-8725)." }, { "id": "Encounter.performer.assignedEntity", "path": "Encounter.performer.assignedEntity", "comment": "The performer, if present, SHALL contain exactly one [1..1] assignedEntity (CONF:1198-8726)." }, { "id": "Encounter.performer.assignedEntity.code", "path": "Encounter.performer.assignedEntity.code", "comment": "This assignedEntity MAY contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1198-8727).", "binding": { "strength": "preferred", "valueSet": "http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.114222.4.11.1066" } }, { "id": "Encounter.participant", "path": "Encounter.participant", "slicing": { "discriminator": [ { "type": "profile", "path": "participantRole" }, { "type": "value", "path": "typeCode" } ], "rules": "open" } }, { "id": "Encounter.participant:location", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.participant", "sliceName": "location", "short": "π¨π¦πππ: Location", "comment": "In Encounter Summaries the Encounter Location will also be present in the document header at componentOf/encompassingEncounter/location, but in Patient Summaries, componentOf/encompassingEncounter SHALL NOT be present.", "min": 0, "max": "*" }, { "id": "Encounter.participant:location.typeCode", "path": "Encounter.participant.typeCode", "comment": "SHALL contain exactly one [1..1] @typeCode=\"LOC\" Location (CodeSystem: HL7ParticipationType urn:oid:2.16.840.1.113883.5.90 STATIC) (CONF:1198-8740).", "fixedCode": "LOC" }, { "id": "Encounter.participant:location.participantRole", "path": "Encounter.participant.participantRole", "comment": "SHALL contain exactly one [1..1] Service Delivery Location (identifier: urn:oid:2.16.840.1.113883.10.20.22.4.32) (CONF:1198-14903).", "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/ServiceDeliveryLocation" ] } ] }, { "id": "Encounter.entryRelationship", "path": "Encounter.entryRelationship", "slicing": { "discriminator": [ { "type": "profile", "path": "act" }, { "type": "profile", "path": "observation" } ], "rules": "open" } }, { "id": "Encounter.entryRelationship:indication", "path": "Encounter.entryRelationship", "sliceName": "indication", "comment": "MAY contain zero or more [0..*] entryRelationship (CONF:1198-8722) such that it", "min": 0, "max": "*" }, { "id": "Encounter.entryRelationship:indication.typeCode", "path": "Encounter.entryRelationship.typeCode", "comment": "SHALL contain exactly one [1..1] @typeCode=\"RSON\" Has Reason (CodeSystem: HL7ActRelationshipType urn:oid:2.16.840.1.113883.5.1002 STATIC) (CONF:1198-8723).", "fixedCode": "RSON" }, { "id": "Encounter.entryRelationship:indication.observation", "path": "Encounter.entryRelationship.observation", "comment": "SHALL contain exactly one [1..1] Indication (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.19:2014-06-09) (CONF:1198-14899).", "min": 1, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/Indication" ] } ] }, { "id": "Encounter.entryRelationship:diagnosis", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.entryRelationship", "sliceName": "diagnosis", "short": "π¨π¦πππ: Diagnosis", "comment": "MAY contain zero or more [0..*] entryRelationship (CONF:1198-15492) such that it", "min": 0, "max": "*" }, { "id": "Encounter.entryRelationship:diagnosis.act", "path": "Encounter.entryRelationship.act", "min": 1, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Act", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/EncounterDiagnosis" ] } ] }, { "id": "Encounter.entryRelationship:observation", "extension": [ { "url": "http://hl7.org/fhir/us/core/StructureDefinition/uscdi-requirement", "valueBoolean": true } ], "path": "Encounter.entryRelationship", "sliceName": "observation", "short": "π¨π¦πππ: Interpreter Needed Observation", "comment": "SHALL contain exactly one [1..1] Interpreter Needed Observation (identifier: urn:hl7ii:2.16.840.1.113883.10.20.22.4.515:2025-05-01).", "min": 0, "max": "*" }, { "id": "Encounter.entryRelationship:observation.observation", "path": "Encounter.entryRelationship.observation", "min": 1, "type": [ { "code": "http://hl7.org/cda/stds/core/StructureDefinition/Observation", "profile": [ "http://hl7.org/cda/us/ccda/StructureDefinition/InterpreterNeededObservation" ] } ] } ] } }