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

Logical Model: IPS Result Organizer

Official URL: http://art-decor.org/fhir/StructureDefinition/2.16.840.1.113883.10.22.4.9--20170302000000 Version: 1.1.0-ballot
Draft as of 2017-03-02 Computable Name: IPSResultOrganizer
Other Identifiers: OID:2.16.840.1.113883.10.22.4.9 (use: official, )

This template provides a mechanism for grouping result observations. It contains information applicable to all of the contained result observations. The Result Organizer code categorizes the contained results into one of several commonly accepted values (e.g., “Hematology”, “Chemistry”, “Nuclear Medicine”). If any Result Observation within the organizer has a statusCode of “active”, the Result Organizer must also have a statusCode of “active”. However, the results selected for a patient summary are most often final results, with status “completed”. So in most cases, the statusCode of the Organizer is “completed”.

The  result observations contained within the organizer may use either of these templates:

  • Laboratory Result Observation

  • Radiology Result Observation

  • Pathology Result Observation
  • Result Observation (most generic template used whenever none of the above is applicable)

One Result Organizer entry groups results, which have a common context of production:

  • common specialty (imaging, bacteriology, serology, chemistry,  surgical pathology, clinical, radiology …), 
  • common overall interpretation, (which interprets the set of results of the Organizer),
  • common biologic specimen for in vitro diagnostic observations, 
  • common associated illustrative image (ObservationMedia).

The ultimate choice for sorting out results between Organizer entries belongs to the authoring person or system of the section.

Usage:

Formal Views of Template Content

Description of Template, Differentials, Snapshots and how the different presentations work.

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.9
... @classCode 1..1 code
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... low 0..1 IVXB_TS
.... high 0..1 IVXB_TS
... performer S 0..* Performer2
... author S 0..* Author

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.9
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... low 0..1 IVXB_TS
.... high 0..1 IVXB_TS
... performer S 0..* Performer2
... author S 0..* Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:primary S 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.9
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: text (urn:hl7-org:sdtc)
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer S 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... component 0..* OrganizerComponent

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator

This structure is derived from Organizer

Summary

Mandatory: 7 elements
Must-Support: 5 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organizer.templateId

Differential View

This structure is derived from Organizer

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.9
... @classCode 1..1 code
... @moodCode 1..1 code Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... low 0..1 IVXB_TS
.... high 0..1 IVXB_TS
... performer S 0..* Performer2
... author S 0..* Author

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
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.9
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... low 0..1 IVXB_TS
.... high 0..1 IVXB_TS
... performer S 0..* Performer2
... author S 0..* Author

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organizer 0..* Organizer XML Namespace: urn:hl7-org:v3
Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component
Base for all types and resources
Instance of this type are validated by templateId
Logical Container: ClinicalDocument (CDA Class)
... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
... realmCode 0..* CS
... typeId 0..1 II
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @assigningAuthorityName 0..1 st
.... @displayable 0..1 bl
.... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
.... @extension 1..1 st
.... templateId:primary S 1..1 II
..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
..... @assigningAuthorityName 0..1 st
..... @displayable 0..1 bl
..... @root 1..1 string Fixed Value: 2.16.840.1.113883.10.22.4.9
..... @extension 0..1 st
... @classCode 1..1 code Binding: XActClassDocumentEntryOrganizer (2.0.0) (required)
... @moodCode 1..1 code Binding: CDAActMood (required)
Fixed Value: EVN
... id 0..* II
... code S 1..1 CD Binding: IPS Results Organizer (required): IPS Results Organizer

... sdtcText 0..1 ED XML Namespace: urn:hl7-org:sdtc
XML: text (urn:hl7-org:sdtc)
... statusCode S 1..1 CS Binding: x_ActStatusActiveComplete (required): x_ActStatusActiveComplete

... effectiveTime 0..1 IVL_TS
.... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
.... @value 0..1 ts Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz]
.... @operator 0..1 cs Binding: CDASetOperator (required)
.... low 0..1 IVXB_TS
.... center 0..1 TS
.... width 0..1 PQ
.... high 0..1 IVXB_TS
... subject 0..1 Subject
... specimen 0..* Specimen
... performer S 0..* Performer2
... author S 0..* Author
... informant 0..* Informant
... participant 0..* Participant2
... reference 0..* Reference
... precondition 0..* Precondition
... sdtcPrecondition2 0..* Precondition2 XML Namespace: urn:hl7-org:sdtc
XML: precondition2 (urn:hl7-org:sdtc)
... component 0..* OrganizerComponent

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
Organizer.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.typeId.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.templateId:primary.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.classCoderequiredXActClassDocumentEntryOrganizer
http://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0
Organizer.moodCoderequiredFixed Value: EVN
http://hl7.org/cda/stds/core/ValueSet/CDAActMood
Organizer.coderequiredIPSResultsOrganizer (a valid code from LOINC)
http://art-decor.org/fhir/ValueSet/2.16.840.1.113883.11.22.37--20170523000000
from this IG
Organizer.statusCoderequiredXActStatusActiveComplete
http://terminology.hl7.org/ValueSet/v3-xActStatusActiveComplete
Organizer.effectiveTime.nullFlavorrequiredCDANullFlavor
http://hl7.org/cda/stds/core/ValueSet/CDANullFlavor
Organizer.effectiveTime.operatorrequiredCDASetOperator
http://hl7.org/cda/stds/core/ValueSet/CDASetOperator

This structure is derived from Organizer

Summary

Mandatory: 7 elements
Must-Support: 5 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

  • The element 2 is sliced based on the values of Organizer.templateId

 

Other representations of profile: CSV, Excel