International Patient Summary (IPS), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 1.1.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-IPS/ and changes regularly. See the Directory of published versions
Draft as of 2024-08-04 |
Definitions for the 2.16.840.1.113883.10.22.4.17--20240804110835 logical model.
Guidance on how to interpret the contents of this table can be found here
0. Procedure | |
Control | 0..* |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Procedure.templateId | |
Control | 1..? |
Slicing | This element introduces a set of slices on Procedure.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Procedure.templateId:primary | |
Slice Name | primary |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Procedure.templateId:primary.root | |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.4.17 |
8. Procedure.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PROC |
10. Procedure.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 )MoodCodeEvnInt |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
12. Procedure.id | |
Control | 0..* |
Must Support | true |
14. Procedure.code | |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Results Laboratory/Pathology Observation (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips )IPS Procedures |
Must Support | true |
16. Procedure.text | |
Definition | The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described. |
Control | 0..1 |
Must Support | true |
18. Procedure.text.reference | |
Control | 1..1 |
Must Support | true |
20. Procedure.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
22. Procedure.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000 )ActStatusActiveCompletedAbortedCancelled |
Must Support | true |
24. Procedure.effectiveTime | |
Control | 1..1 |
Must Support | true |
26. Procedure.targetSiteCode | |
Control | 0..* |
Binding | The codes SHOULD be taken from IPS Body Site (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips )IPS Body Site |
28. Procedure.participant | |
Definition | The device is represented as a participant in the procedure structure. The following descriptions apply to the device structure. |
Control | 1..* |
Must Support | true |
30. Procedure.participant.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEV |
32. Procedure.participant.participantRole | |
Control | 1..1 |
Must Support | true |
34. Procedure.participant.participantRole.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | MANU |
36. Procedure.participant.participantRole.id | |
Definition | The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number) may be known to the provider or patient. |
Control | 0..* |
Must Support | true |
38. Procedure.participant.participantRole.playingDevice | |
Definition | The playingDevice element describes the device instance. |
Control | 1..1 |
Must Support | true |
40. Procedure.participant.participantRole.playingDevice.classCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEV |
42. Procedure.participant.participantRole.playingDevice.determinerCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
44. Procedure.participant.participantRole.playingDevice.code | |
Definition | The device code describes the type of device (e.g. arm prosthesis, arterial stent). |
Control | 1..1 |
Binding | The codes SHOULD be taken from Absent or Unknown Devices (preferred to http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips )Absent or Unknown Devices |
Must Support | true |
46. Procedure.entryRelationship | |
Control | 1..? |
Slicing | This element introduces a set of slices on Procedure.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
48. Procedure.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Invariants | entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) () |
50. Procedure.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | COMP |
52. Procedure.entryRelationship:entryRelationship-1.inversionInd | |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
54. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference) |
Guidance on how to interpret the contents of this table can be found here
0. Procedure | |
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. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Procedure.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 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Procedure.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
4. Procedure.templateId:primary | |
Slice Name | primary |
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 |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
6. Procedure.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.17 |
8. Procedure.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActClassProcedure (required to http://terminology.hl7.org/ValueSet/v3-ActClassProcedure ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PROC |
10. Procedure.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 )MoodCodeEvnInt |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
12. Procedure.id | |
Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Short | Logical id of this artifact |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
Control | 0..*1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IIstring |
Is Modifier | false |
Must Support | true |
14. Procedure.code | |
Definition | Drawn from concept domain ActCode The specific procedure that is performed. Use text if the exact nature of the procedure cannot be coded (e.g. "Laparoscopic Appendectomy"). |
Short | Identification of the procedure |
Control | 10..1 |
Binding | The codes SHOULD be taken from For example codes, see IPS Results Laboratory/Pathology Observationhttp://hl7.org/fhir/ValueSet/procedure-code (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips )IPS Procedures A code to identify a specific procedure . |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CDCodeableConcept |
Is Modifier | false |
Must Support | true |
Requirements | 0..1 to account for primarily narrative only resources. |
Alternate Names | type |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
16. Procedure.text | |
Definition | The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described. A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Short | Text summary of the resource, for human interpretation |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EDNarrative |
Is Modifier | false |
Must Support | true |
Alternate Names | narrative, html, xhtml, display |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
18. Procedure.text.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. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Must Support | true |
Label | Reference |
20. Procedure.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
22. Procedure.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000 )ActStatusActiveCompletedAbortedCancelled |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
24. Procedure.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
26. Procedure.targetSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Binding | The codes SHOULD be taken from IPS Body Site (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips )IPS Body Site |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
28. Procedure.participant | |
Definition | The device is represented as a participant in the procedure structure. The following descriptions apply to the device structure. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
Must Support | true |
30. Procedure.participant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEV |
32. Procedure.participant.participantRole | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
Must Support | true |
34. Procedure.participant.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | MANU |
36. Procedure.participant.participantRole.id | |
Definition | The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number) may be known to the provider or patient. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
38. Procedure.participant.participantRole.playingDevice | |
Definition | The playingDevice element describes the device instance. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
Must Support | true |
40. Procedure.participant.participantRole.playingDevice.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassDevice (required to http://terminology.hl7.org/ValueSet/v3-EntityClassDevice ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | DEV |
Fixed Value | DEV |
42. Procedure.participant.participantRole.playingDevice.determinerCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
44. Procedure.participant.participantRole.playingDevice.code | |
Definition | The device code describes the type of device (e.g. arm prosthesis, arterial stent). |
Control | 1..1 |
Binding | The codes SHOULD be taken from Absent or Unknown Devices (preferred to http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips )Absent or Unknown Devices |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
46. Procedure.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Procedure.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
48. Procedure.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Invariants | entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) () |
50. Procedure.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | COMP |
52. Procedure.entryRelationship:entryRelationship-1.inversionInd | |
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. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
54. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..1 This element is affected by the following invariants: MD1557037N1l27l287l23l17, MD1557037N1l27l287l23l19, MD1557037N1l27l287l23l21 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference) |
Is Modifier | false |
Must Support | true |
Invariants | MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element () MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. () MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element () |
Guidance on how to interpret the contents of this table can be found here
0. Procedure | |
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. |
Short | Base for all types and resources |
Control | 0..* |
Is Modifier | false |
Logical Container | ClinicalDocument (CDA Class) |
Validation | Instance of this type are validated by templateId |
XML Format | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Procedure.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
4. Procedure.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
6. Procedure.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
8. Procedure.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
10. Procedure.typeId.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
12. Procedure.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
14. Procedure.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
16. Procedure.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
18. Procedure.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 |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Slicing | This element introduces a set of slices on Procedure.templateId . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
20. Procedure.templateId:primary | |
Slice Name | primary |
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 |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
22. Procedure.templateId:primary.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
24. Procedure.templateId:primary.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
26. Procedure.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
28. Procedure.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.10.22.4.17 |
30. Procedure.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
32. Procedure.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActClassProcedure (required to http://terminology.hl7.org/ValueSet/v3-ActClassProcedure ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | PROC |
34. Procedure.moodCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.20.9.18--20160623000000 )MoodCodeEvnInt |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
36. Procedure.id | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
38. Procedure.code | |
Definition | Drawn from concept domain ActCode |
Control | 1..1 |
Binding | The codes SHOULD be taken from IPS Results Laboratory/Pathology Observation (preferred to http://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ips )IPS Procedures |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
Must Support | true |
40. Procedure.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
42. Procedure.text | |
Definition | The element if present points to the text describing the data being recorded; including any dates, comments, et cetera. The contains a URI in value attribute. This URI points to the free text description of the element (problem, procedure,...) in the document that is being described. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Must Support | true |
44. Procedure.text.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
46. Procedure.text.compression | |
Definition | Indicates whether the raw byte data is compressed, and what compression algorithm was used. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDACompressionAlgorithm (required to http://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Compression |
48. Procedure.text.integrityCheck | |
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. |
Control | 0..1 |
Type | base64Binary(bin: Binary Data) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Integrity Check |
50. Procedure.text.integrityCheckAlgorithm | |
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. |
Control | 0..1 |
Binding | The codes SHALL be taken from IntegrityCheckAlgorithm (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Integrity Check Algorithm |
52. Procedure.text.language | |
Definition | For character based information the language property specifies the human language of the text. |
Control | 0..1 |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Language |
54. Procedure.text.mediaType | |
Definition | Identifies the type of the encapsulated data and identifies a method to interpret or render the data. |
Control | 0..1 |
Binding | For example codes, see MediaType (example to http://terminology.hl7.org/ValueSet/v3-MediaType ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Media Type |
56. Procedure.text.representation | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDABinaryDataEncoding (required to http://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
58. Procedure.text.xmlText | |
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.) |
Short | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. |
Comments | This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as unadorned text. |
60. Procedure.text.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. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
Must Support | true |
Label | Reference |
62. Procedure.text.reference.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
64. Procedure.text.reference.value | |
Definition | When used it shall refer to the narrative, typically #{label}-{generated-id}, e.g. #xxx-1 |
Control | 1..1 |
Type | url |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
66. Procedure.text.reference.useablePeriod | |
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
Control | 0..* |
Type | Choice of: http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/EIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/PIVL-TS, http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/cda/stds/core/StructureDefinition/SXPR-TS |
XML Format | The type of this property is determined using the xsi:type attribute. |
Label | Useable Period |
68. Procedure.text.reference.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
Control | 0..* |
Binding | The codes SHALL be taken from TelecommunicationAddressUse (2.0.0) (required to http://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Use Code |
70. Procedure.text.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
Label | Thumbnail |
72. Procedure.statusCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ActStatusActiveCompletedAbortedCancelled (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000 )ActStatusActiveCompletedAbortedCancelled |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
Must Support | true |
74. Procedure.effectiveTime | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
Must Support | true |
76. Procedure.priorityCode | |
Control | 0..1 |
Binding | For example codes, see ActPriority (example to http://terminology.hl7.org/ValueSet/v3-ActPriority ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
78. Procedure.languageCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from AllLanguages (required to http://hl7.org/fhir/ValueSet/all-languages ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
80. Procedure.methodCode | |
Definition | Drawn from concept domain ProcedureMethod |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
82. Procedure.approachSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
84. Procedure.targetSiteCode | |
Definition | Drawn from concept domain ActSite |
Control | 0..* |
Binding | The codes SHOULD be taken from IPS Body Site (preferred to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips )IPS Body Site |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
86. Procedure.subject | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
88. Procedure.specimen | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
90. Procedure.performer | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
92. Procedure.author | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
94. Procedure.informant | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
96. Procedure.participant | |
Definition | The device is represented as a participant in the procedure structure. The following descriptions apply to the device structure. |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
Must Support | true |
98. Procedure.participant.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
100. Procedure.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
102. Procedure.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
104. Procedure.participant.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
106. Procedure.participant.typeId.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
108. Procedure.participant.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
110. Procedure.participant.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
112. Procedure.participant.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
114. Procedure.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
116. Procedure.participant.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDAParticipationType (required to http://hl7.org/cda/stds/core/ValueSet/CDAParticipationType ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | DEV |
118. Procedure.participant.contextControlCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from CDAContextControl (required to http://hl7.org/cda/stds/core/ValueSet/CDAContextControl ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | OP |
120. Procedure.participant.sdtcFunctionCode | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual namefunctionCode . |
122. Procedure.participant.time | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
124. Procedure.participant.awarenessCode | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
126. Procedure.participant.participantRole | |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
Must Support | true |
128. Procedure.participant.participantRole.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
130. Procedure.participant.participantRole.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
132. Procedure.participant.participantRole.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
134. Procedure.participant.participantRole.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
136. Procedure.participant.participantRole.typeId.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
138. Procedure.participant.participantRole.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
140. Procedure.participant.participantRole.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
142. Procedure.participant.participantRole.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
144. Procedure.participant.participantRole.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
146. Procedure.participant.participantRole.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from CDARoleClassRoot (required to http://hl7.org/cda/stds/core/ValueSet/CDARoleClassRoot ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | ROL |
Fixed Value | MANU |
148. Procedure.participant.participantRole.id | |
Definition | The device ID, e.g. using UDI, is represented by the id element of the participant role. This element is optional, as not all production identifiers (e.g., serial number, lot/batch number, distinct identification number) may be known to the provider or patient. |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
Must Support | true |
150. Procedure.participant.participantRole.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/IdentifiedBy |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameidentifiedBy . |
152. Procedure.participant.participantRole.code | |
Control | 0..1 |
Binding | For example codes, see CDARoleCode (example to http://hl7.org/cda/stds/core/ValueSet/CDARoleCode ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
154. Procedure.participant.participantRole.addr | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
156. Procedure.participant.participantRole.telecom | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
158. Procedure.participant.participantRole.playingDevice | |
Definition | The playingDevice element describes the device instance. |
Control | 1..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
Must Support | true |
160. Procedure.participant.participantRole.playingDevice.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
162. Procedure.participant.participantRole.playingDevice.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
164. Procedure.participant.participantRole.playingDevice.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
166. Procedure.participant.participantRole.playingDevice.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
168. Procedure.participant.participantRole.playingDevice.typeId.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
170. Procedure.participant.participantRole.playingDevice.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
172. Procedure.participant.participantRole.playingDevice.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
174. Procedure.participant.participantRole.playingDevice.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
176. Procedure.participant.participantRole.playingDevice.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
178. Procedure.participant.participantRole.playingDevice.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityClassDevice (required to http://terminology.hl7.org/ValueSet/v3-EntityClassDevice ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | DEV |
Fixed Value | DEV |
180. Procedure.participant.participantRole.playingDevice.determinerCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from EntityDeterminer (required to http://terminology.hl7.org/ValueSet/v3-EntityDeterminer ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
182. Procedure.participant.participantRole.playingDevice.code | |
Definition | The device code describes the type of device (e.g. arm prosthesis, arterial stent). |
Control | 1..1 |
Binding | The codes SHOULD be taken from Absent or Unknown Devices (preferred to http://hl7.org/fhir/uv/ips/ValueSet/absent-or-unknown-devices-uv-ips )Absent or Unknown Devices |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
Must Support | true |
184. Procedure.participant.participantRole.playingDevice.manufacturerModelName | |
Control | 0..1 |
Binding | For example codes, see Manufacturer Model Name Example (example to http://terminology.hl7.org/ValueSet/v3-ManufacturerModelNameExample ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC |
186. Procedure.participant.participantRole.playingDevice.softwareName | |
Control | 0..1 |
Binding | For example codes, see Software Name Example (example to http://terminology.hl7.org/ValueSet/v3-SoftwareNameExample ) |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SC |
188. Procedure.participant.participantRole.playingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
190. Procedure.participant.participantRole.scopingEntity | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
192. Procedure.entryRelationship | |
Control | 1..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Slicing | This element introduces a set of slices on Procedure.entryRelationship . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
194. Procedure.entryRelationship:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
Invariants | entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) () |
196. Procedure.entryRelationship:entryRelationship-1.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
198. Procedure.entryRelationship:entryRelationship-1.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
200. Procedure.entryRelationship:entryRelationship-1.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. |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
202. Procedure.entryRelationship:entryRelationship-1.typeId.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from CDANullFlavor (required to http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor ) |
Type | code(cs: Coded Simple Value) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Exceptional Value Detail |
204. Procedure.entryRelationship:entryRelationship-1.typeId.assigningAuthorityName | |
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. |
Control | 0..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Assigning Authority Name |
206. Procedure.entryRelationship:entryRelationship-1.typeId.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Displayable |
208. Procedure.entryRelationship:entryRelationship-1.typeId.root | |
Definition | Identifies the type as an HL7 Registered model |
Control | 1..1 |
Type | string(oid: ISO Object Identifier, uuid: DCE Universal Unique Identifier, ruid: HL7 Reserved Identifier Scheme) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Root |
Fixed Value | 2.16.840.1.113883.1.3 |
210. Procedure.entryRelationship:entryRelationship-1.typeId.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 1..1 |
Type | string(st: Character String) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Label | Extension |
212. Procedure.entryRelationship:entryRelationship-1.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 |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
214. Procedure.entryRelationship:entryRelationship-1.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from x_ActRelationshipEntryRelationship (required to http://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | COMP |
216. Procedure.entryRelationship:entryRelationship-1.inversionInd | |
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. |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Fixed Value | true |
218. Procedure.entryRelationship:entryRelationship-1.contextConductionInd | |
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. |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
Default Value | true |
220. Procedure.entryRelationship:entryRelationship-1.negationInd | |
Control | 0..1 |
Type | boolean(bl: Boolean) |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
XML Format | In the XML format, this property is represented as an attribute. |
222. Procedure.entryRelationship:entryRelationship-1.sequenceNumber | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/INT |
224. Procedure.entryRelationship:entryRelationship-1.seperatableInd | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/BL |
226. Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | |
Slice Name | entryRelationship-1 |
Definition | Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type. |
Short | Base for all types and resources |
Control | 1..1 This element is affected by the following invariants: MD1557037N1l27l287l23l17, MD1557037N1l27l287l23l19, MD1557037N1l27l287l23l21 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Act(IPS Internal Reference) |
Is Modifier | false |
Must Support | true |
Invariants | MD1557037N1l27l287l23l17: The @moodCode of the reference SHALL match the @moodCode of the referenced element () MD1557037N1l27l287l23l19: The root and extension attributes SHALL identify an element defined elsewhere in the same document. () MD1557037N1l27l287l23l21: The code of the reference SHALL match the code of the referenced element () |
228. Procedure.entryRelationship:entryRelationship-1.encounter | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Encounter |
230. Procedure.entryRelationship:entryRelationship-1.observation | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Observation |
232. Procedure.entryRelationship:entryRelationship-1.observationMedia | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/ObservationMedia |
234. Procedure.entryRelationship:entryRelationship-1.organizer | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Organizer |
236. Procedure.entryRelationship:entryRelationship-1.procedure | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Procedure |
238. Procedure.entryRelationship:entryRelationship-1.regionOfInterest | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/RegionOfInterest |
240. Procedure.entryRelationship:entryRelationship-1.substanceAdministration | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/SubstanceAdministration |
242. Procedure.entryRelationship:entryRelationship-1.supply | |
Control | 0..1 |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Supply |
244. Procedure.reference | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
246. Procedure.precondition | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
248. Procedure.sdtcPrecondition2 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition2 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameprecondition2 . |
250. Procedure.sdtcInFulfillmentOf1 | |
Control | 0..* |
Type | http://hl7.org/cda/stds/core/StructureDefinition/InFulfillmentOf1 |
XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual nameinFulfillmentOf1 . |