International Patient Summary (IPS)
1.1.0-ballot - CI Build
International Patient Summary (IPS)
1.1.0-ballot - CI Build
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
| Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.38--20200508173848 | Version: 1.1.0-ballot | |||
| Draft as of 2020-05-08 | Computable Name: IPSPlannedProcedure | |||
| Other Identifiers: OID:2.16.840.1.113883.10.22.4.38 (use: official, ) | ||||
The procedure entry is used to record procedures which are planned for in the future.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Procedure
| Path | Conformance | ValueSet | URI |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Procedure |
0..* | Procedure | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:primary |
S | 1..1 | II | |
   @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.38 | |
 @classCode |
1..1 | code | Binding: ActClassProcedure (required) Fixed Value: PROC | |
| @moodCode |
1..1 | code | Binding: x_DocumentProcedureMood (required) Required Pattern: RQO | |
 id |
S | 0..* | II | |
| code |
S | 1..1 | CD | Binding: IPS Results Laboratory/Pathology Observation (preferred): IPS Procedures |
| text |
S | 0..1 | ED | |
 reference |
S | 1..1 | TEL | |
 @value |
1..1 | url | ||
| statusCode |
S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled |
| effectiveTime |
0..1 | IVL_TS | ||
| targetSiteCode |
0..* | CD | Binding: IPS Body Site (preferred): IPS Body Site | |
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by value:profile | |
| entryRelationship:entryRelationship-1 |
C | 0..* | EntryRelationship | entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
 @typeCode |
1..1 | code | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| @inversionInd |
1..1 | boolean | Fixed Value: true | |
 Slices for act |
Content/Rules for all slices | |||
 act:entryRelationship-1 |
SC | 1..1 | IPSEntryInternalReference | Base for all types and resources 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Procedure.classCode | required | Fixed Value: PROChttp://terminology.hl7.org/ValueSet/v3-ActClassProcedure | |
| Procedure.moodCode | required | Pattern: RQOhttp://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood | |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG | |
| Procedure.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The code of the reference SHALL match the code of the referenced element : | |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
| Path | Conformance | ValueSet / Code | URI |
| Procedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.classCode | required | Fixed Value: PROChttp://terminology.hl7.org/ValueSet/v3-ActClassProcedure | |
| Procedure.moodCode | required | Pattern: RQOhttp://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood | |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Procedure.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Procedure.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Procedure.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Procedure.text.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.text.reference.use | required | TelecommunicationAddressUsehttp://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Procedure.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG | |
| Procedure.entryRelationship:entryRelationship-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.entryRelationship:entryRelationship-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The code of the reference SHALL match the code of the referenced element : | |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
This structure is derived from Procedure
Summary
Mandatory: 8 elements(5 nested mandatory elements)
Must-Support: 6 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Procedure
| Path | Conformance | ValueSet | URI |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG |
| Id | Grade | Path(s) | Details | Requirements |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Procedure |
0..* | Procedure | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, @negationInd, text, statusCode, effectiveTime, priorityCode, languageCode, methodCode, approachSiteCode, targetSiteCode, subject, specimen, performer, author, informant, participant, entryRelationship, reference, precondition, sdtcPrecondition2, sdtcInFulfillmentOf1 Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:primary |
S | 1..1 | II | |
| @root |
1..1 | string | Fixed Value: 2.16.840.1.113883.10.22.4.38 | |
| @classCode |
1..1 | code | Binding: ActClassProcedure (required) Fixed Value: PROC | |
| @moodCode |
1..1 | code | Binding: x_DocumentProcedureMood (required) Required Pattern: RQO | |
| id |
S | 0..* | II | |
| code |
S | 1..1 | CD | Binding: IPS Results Laboratory/Pathology Observation (preferred): IPS Procedures |
| text |
S | 0..1 | ED | |
| reference |
S | 1..1 | TEL | |
| @value |
1..1 | url | ||
| statusCode |
S | 1..1 | CS | Binding: ActStatusActiveCompletedAbortedCancelled (required): ActStatusActiveCompletedAbortedCancelled |
| effectiveTime |
0..1 | IVL_TS | ||
| targetSiteCode |
0..* | CD | Binding: IPS Body Site (preferred): IPS Body Site | |
| Slices for entryRelationship |
1..* | EntryRelationship | Slice: Unordered, Open by value:profile | |
| entryRelationship:entryRelationship-1 |
C | 0..* | EntryRelationship | entryRelationship-1: contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) |
| @typeCode |
1..1 | code | Binding: x_ActRelationshipEntryRelationship (required) Fixed Value: COMP | |
| @inversionInd |
1..1 | boolean | Fixed Value: true | |
| Slices for act |
Content/Rules for all slices | |||
| act:entryRelationship-1 |
SC | 1..1 | IPSEntryInternalReference | Base for all types and resources 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 |
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code | URI |
| Procedure.classCode | required | Fixed Value: PROChttp://terminology.hl7.org/ValueSet/v3-ActClassProcedure | |
| Procedure.moodCode | required | Pattern: RQOhttp://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood | |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG | |
| Procedure.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The code of the reference SHALL match the code of the referenced element : | |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
Snapshot View
| Path | Conformance | ValueSet / Code | URI |
| Procedure.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.classCode | required | Fixed Value: PROChttp://terminology.hl7.org/ValueSet/v3-ActClassProcedure | |
| Procedure.moodCode | required | Pattern: RQOhttp://terminology.hl7.org/ValueSet/v3-xDocumentProcedureMood | |
| Procedure.code | preferred | IPSResultsLaboratoryPathologyhttp://hl7.org/fhir/uv/ips/ValueSet/procedures-uv-ipsfrom this IG | |
| Procedure.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Procedure.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Procedure.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Procedure.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Procedure.text.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.text.reference.use | required | TelecommunicationAddressUsehttp://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 | |
| Procedure.statusCode | required | ActStatusActiveCompletedAbortedCancelledhttp://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.22--20170502000000from this IG | |
| Procedure.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
| Procedure.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
| Procedure.targetSiteCode | preferred | IPSTargetSiteCodehttp://hl7.org/fhir/uv/ips/ValueSet/target-site-uv-ipsfrom this IG | |
| Procedure.entryRelationship:entryRelationship-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.entryRelationship:entryRelationship-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Procedure.entryRelationship:entryRelationship-1.typeCode | required | Fixed Value: COMPhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntryRelationship |
| Id | Grade | Path(s) | Details | Requirements |
| MD1557037N1l27l287l23l17 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The @moodCode of the reference SHALL match the @moodCode of the referenced element : | |
| MD1557037N1l27l287l23l19 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The root and extension attributes SHALL identify an element defined elsewhere in the same document. : | |
| MD1557037N1l27l287l23l21 | error | Procedure.entryRelationship:entryRelationship-1.act:entryRelationship-1 | The code of the reference SHALL match the code of the referenced element : | |
| entryRelationship-1 | null | Procedure.entryRelationship:entryRelationship-1 | contains IPS Internal Reference 2.16.840.1.113883.10.22.4.31 (2017-05-02) : |
This structure is derived from Procedure
Summary
Mandatory: 8 elements(5 nested mandatory elements)
Must-Support: 6 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
IG © 2024+ Health Level Seven. Package hl7.cda.uv.ips#1.1.0-ballot based on FHIR 4.0.1. Generated 2024-08-19
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change
