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.30--20240804210307 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.30 |
| 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 |
| 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 | EVN |
| 12. Procedure.code | |
| Definition | LOINC code representing the act of specimen collection |
| Control | 0..1 |
| Must Support | true |
| 14. Procedure.code.code | |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | 33882-2 |
| 16. Procedure.code.codeSystem | |
| XML Format | In the XML format, this property is represented as an attribute. |
| Fixed Value | 2.16.840.1.113883.6.1 |
| 18. Procedure.effectiveTime | |
| Definition | Date and time of specimen collection |
| Control | 0..1 |
| Must Support | true |
| 20. Procedure.methodCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Results Specimen Collection Method (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)IPS Results Specimen Collection Method |
| Must Support | true |
| 22. Procedure.targetSiteCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Body Site (required to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)IPS Body Site |
| Must Support | true |
| 24. Procedure.participant | |
| Definition | One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...) |
| Control | 0..1 |
| Must Support | true |
| 26. 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 | PRD |
| 28. Procedure.participant.participantRole | |
| Control | 1..1 |
| Must Support | true |
| 30. Procedure.participant.participantRole.classCode | |
| Control | 0..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 | SPEC |
| 32. Procedure.participant.participantRole.id | |
| Control | 0..1 |
| Must Support | true |
| 34. Procedure.participant.participantRole.playingEntity | |
| Control | 1..1 |
| Must Support | true |
| 36. Procedure.participant.participantRole.playingEntity.classCode | |
| Control | 0..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 | ENT |
| 38. Procedure.participant.participantRole.playingEntity.determinerCode | |
| Control | 0..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 |
| 40. Procedure.participant.participantRole.playingEntity.code | |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from IPS Specimen Type (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)IPS Specimen Type |
| Must Support | true |
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.30 |
| 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 x_DocumentProcedureMood (required to http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood) |
| 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 | EVN |
| 12. Procedure.code | |
| Definition | LOINC code representing the act of specimen collection 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 | 0..1 |
| 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())) |
| 14. Procedure.code.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. |
| 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 | Code |
| Fixed Value | 33882-2 |
| 16. Procedure.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..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 | Code System |
| Fixed Value | 2.16.840.1.113883.6.1 |
| 18. Procedure.effectiveTime | |
| Definition | Date and time of specimen collection |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Must Support | true |
| 20. Procedure.methodCode | |
| Definition | Drawn from concept domain ProcedureMethod |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Results Specimen Collection Method (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)IPS Results Specimen Collection Method |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Must Support | true |
| 22. Procedure.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Body Site (required to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)IPS Body Site |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| Must Support | true |
| 24. Procedure.participant | |
| Definition | One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...) |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| Must Support | true |
| 26. 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 | PRD |
| 28. Procedure.participant.participantRole | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
| Must Support | true |
| 30. Procedure.participant.participantRole.classCode | |
| Control | 0..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 | SPEC |
| 32. Procedure.participant.participantRole.id | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Must Support | true |
| 34. Procedure.participant.participantRole.playingEntity | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| Must Support | true |
| 36. Procedure.participant.participantRole.playingEntity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot) |
| 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 | ENT |
| Fixed Value | ENT |
| 38. Procedure.participant.participantRole.playingEntity.determinerCode | |
| Control | 0..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 |
| 40. Procedure.participant.participantRole.playingEntity.code | |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from IPS Specimen Type (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)IPS Specimen Type |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Must Support | true |
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.30 |
| 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 x_DocumentProcedureMood (required to http://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood) |
| 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 | EVN |
| 36. Procedure.id | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| 38. Procedure.code | |
| Definition | LOINC code representing the act of specimen collection |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| Must Support | true |
| 40. Procedure.code.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 |
| 42. Procedure.code.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. |
| 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 | Code |
| Fixed Value | 33882-2 |
| 44. Procedure.code.codeSystem | |
| Definition | Specifies the code system that defines the code. |
| Control | 0..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 | Code System |
| Fixed Value | 2.16.840.1.113883.6.1 |
| 46. Procedure.code.codeSystemName | |
| Definition | The common name of the coding system. |
| 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 | Code System Name |
| 48. Procedure.code.codeSystemVersion | |
| Definition | If applicable, a version descriptor defined specifically for the given code system. |
| 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 | Code System Version |
| 50. Procedure.code.displayName | |
| Definition | A name or title for the code, under which the sending system shows the code value to its users. |
| 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 | Display Name |
| 52. Procedure.code.sdtcValueSet | |
| Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
| Control | 0..1 |
| Type | string(oid: ISO Object Identifier) |
| 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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSet. |
| 54. Procedure.code.sdtcValueSetVersion | |
| 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. |
| 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.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namevalueSetVersion. |
| 56. Procedure.code.originalText | |
| Definition | The text or phrase used as the basis for the coding. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| Label | Original Text |
| 58. Procedure.code.qualifier | |
| Definition | Specifies additional codes that increase the specificity of the the primary code. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CR |
| Label | Qualifier |
| 60. Procedure.code.translation | |
| Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| XML Format | The type of this property is determined using the xsi:typeattribute. |
| Label | Translation |
| 62. 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. |
| 64. Procedure.text | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 66. Procedure.statusCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from ActStatus (required to http://terminology.hl7.org/ValueSet/v3-ActStatus) |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CS |
| 68. Procedure.effectiveTime | |
| Definition | Date and time of specimen collection |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| Must Support | true |
| 70. 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 |
| 72. 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 |
| 74. Procedure.methodCode | |
| Definition | Drawn from concept domain ProcedureMethod |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Results Specimen Collection Method (required to http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.76--20240802105320)IPS Results Specimen Collection Method |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Must Support | true |
| 76. Procedure.approachSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| 78. Procedure.targetSiteCode | |
| Definition | Drawn from concept domain ActSite |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IPS Body Site (required to http://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ips)IPS Body Site |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CD |
| Must Support | true |
| 80. Procedure.subject | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Subject |
| 82. Procedure.specimen | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Specimen |
| 84. Procedure.performer | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Performer2 |
| 86. Procedure.author | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Author |
| 88. Procedure.informant | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Informant |
| 90. Procedure.participant | |
| Definition | One single participant, which is the product of the procedure (PRD), role of specimen (SPEC) played by the playingEntity, which conveys the type of specimen collected (blood, urine, tissue, ...) |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Participant2 |
| Must Support | true |
| 92. 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 |
| 94. 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 |
| 96. 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 |
| 98. 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 |
| 100. 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 |
| 102. 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 |
| 104. 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 |
| 106. 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 |
| 108. 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 |
| 110. 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 | PRD |
| 112. 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 |
| 114. 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. |
| 116. Procedure.participant.time | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/IVL-TS |
| 118. Procedure.participant.awarenessCode | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| 120. Procedure.participant.participantRole | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ParticipantRole |
| Must Support | true |
| 122. 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 |
| 124. 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 |
| 126. 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 |
| 128. 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 |
| 130. 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 |
| 132. 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 |
| 134. 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 |
| 136. 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 |
| 138. 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 |
| 140. Procedure.participant.participantRole.classCode | |
| Control | 0..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 | SPEC |
| 142. Procedure.participant.participantRole.id | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/II |
| Must Support | true |
| 144. 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. |
| 146. 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 |
| 148. Procedure.participant.participantRole.addr | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/AD |
| 150. Procedure.participant.participantRole.telecom | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TEL |
| 152. Procedure.participant.participantRole.playingDevice | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Device |
| 154. Procedure.participant.participantRole.playingEntity | |
| Control | 1..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PlayingEntity |
| Must Support | true |
| 156. Procedure.participant.participantRole.playingEntity.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 |
| 158. Procedure.participant.participantRole.playingEntity.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 |
| 160. Procedure.participant.participantRole.playingEntity.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 |
| 162. Procedure.participant.participantRole.playingEntity.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 |
| 164. Procedure.participant.participantRole.playingEntity.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 |
| 166. Procedure.participant.participantRole.playingEntity.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 |
| 168. Procedure.participant.participantRole.playingEntity.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 |
| 170. Procedure.participant.participantRole.playingEntity.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 |
| 172. Procedure.participant.participantRole.playingEntity.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 |
| 174. Procedure.participant.participantRole.playingEntity.classCode | |
| Control | 0..1 |
| Binding | The codes SHALL be taken from EntityClassRoot (required to http://terminology.hl7.org/ValueSet/v3-EntityClassRoot) |
| 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 | ENT |
| Fixed Value | ENT |
| 176. Procedure.participant.participantRole.playingEntity.determinerCode | |
| Control | 0..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 |
| 178. Procedure.participant.participantRole.playingEntity.code | |
| Control | 1..1 |
| Binding | The codes SHOULD be taken from IPS Specimen Type (preferred to http://hl7.org/uv/ips/fhir/ValueSet/specimen-type)IPS Specimen Type |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/CE |
| Must Support | true |
| 180. Procedure.participant.participantRole.playingEntity.quantity | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PQ |
| 182. Procedure.participant.participantRole.playingEntity.name | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/PN |
| 184. Procedure.participant.participantRole.playingEntity.sdtcBirthTime | |
| Definition | The purpose of this extension is to allow the recording of the subscriber or member of a health plan in cases where the health plan eligibility system has different information on file than the provider does for the patient. |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/TS |
| XML Format | In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual namebirthTime. |
| 186. Procedure.participant.participantRole.playingEntity.desc | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/ED |
| 188. Procedure.participant.participantRole.scopingEntity | |
| Control | 0..1 |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Entity |
| 190. Procedure.entryRelationship | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/EntryRelationship |
| 192. Procedure.reference | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Reference |
| 194. Procedure.precondition | |
| Control | 0..* |
| Type | http://hl7.org/cda/stds/core/StructureDefinition/Precondition |
| 196. 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. |
| 198. 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. |