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.3.1--20161111000000 | Version: 1.1.0-ballot | |||
Draft as of 2016-11-11 | Computable Name: IPSMedicationSummarySection | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.3.1 (use: official, ) |
The medication summary section contains a description of the patient’s medications relevant for the scope of the patient summary. The actual content could depend on the jurisdiction, it could report:
the currently active medications;
the current and past medications considered relevant by the authoring GP;
the patient prescriptions or dispensations automatically extracted by a regional or a national EHR.
In all those cases however medications are documented in the Patient Summary as medication statements.
This section requires either an entry indicating the subject is known not to be on any medications; either an entry indicating that no information is available about medications; or entries summarizing the subject’s medications.
The optional author and informant elements are used when necessary to convey the provenance and authoring of the section content in case it is different from what is announced in the CDA header.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | S | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
@classCode | 0..1 | code | Fixed Value: DOCSECT | |
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.3.1 | |
id | 0..* | II | ||
code | S | 1..1 | CE | |
@code | 0..1 | cs | Fixed Value: 10160-0 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for entry | 1..* | Entry | Slice: Unordered, Open by value:profile | |
entry:entry-1 | SC | 1..1 | Entry | entry-1: contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) |
Slices for substanceAdministration | Content/Rules for all slices | |||
substanceAdministration:entry-1 | S | 1..* | IPSMedicationStatement | |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntry (required): x_ActRelationshipEntry | |
@contextConductionInd | 0..1 | boolean | Fixed Value: true | |
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:component-1 | C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | ?pkp-2? | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | S | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, 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.3.1 | |
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
id | 0..* | II | ||
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@code | 0..1 | cs | Fixed Value: 10160-0 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for entry | 1..* | Entry | Slice: Unordered, Open by value:profile | |
entry:entry-1 | SC | 1..1 | Entry | entry-1: contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntry (required): x_ActRelationshipEntry | |
@contextConductionInd | 0..1 | boolean | Fixed Value: true | |
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:All Slices | Content/Rules for all slices | |||
section | 1..1 | Section | ||
component:component-1 | C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | ?pkp-2? | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
Path | Conformance | ValueSet / Code | URI |
Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Section.entry:entry-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.entry:entry-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component:component-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component:component-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
This structure is derived from Section
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Section
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | S | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) |
@classCode | 0..1 | code | Fixed Value: DOCSECT | |
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.3.1 | |
id | 0..* | II | ||
code | S | 1..1 | CE | |
@code | 0..1 | cs | Fixed Value: 10160-0 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for entry | 1..* | Entry | Slice: Unordered, Open by value:profile | |
entry:entry-1 | SC | 1..1 | Entry | entry-1: contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) |
Slices for substanceAdministration | Content/Rules for all slices | |||
substanceAdministration:entry-1 | S | 1..* | IPSMedicationStatement | |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntry (required): x_ActRelationshipEntry | |
@contextConductionInd | 0..1 | boolean | Fixed Value: true | |
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:component-1 | C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | ?pkp-2? | ||
Documentation for this format |
Path | Conformance | ValueSet | URI |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Section | S | 1..1 | Section | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @ID, @classCode, @moodCode, id, code, title, text, confidentialityCode, languageCode, subject, author, informant, entry, 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.3.1 | |
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
id | 0..* | II | ||
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@code | 0..1 | cs | Fixed Value: 10160-0 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
author | 0..* | Author | ||
informant | 0..* | Informant | ||
Slices for entry | 1..* | Entry | Slice: Unordered, Open by value:profile | |
entry:entry-1 | SC | 1..1 | Entry | entry-1: contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) |
@typeCode | 1..1 | code | Binding: x_ActRelationshipEntry (required): x_ActRelationshipEntry | |
@contextConductionInd | 0..1 | boolean | Fixed Value: true | |
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:All Slices | Content/Rules for all slices | |||
section | 1..1 | Section | ||
component:component-1 | C | 1..1 | InfrastructureRoot | component-1: contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | ?pkp-2? | ||
Documentation for this format |
Path | Conformance | ValueSet / Code | URI |
Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Section.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.classCode | required | Fixed Value: DOCSECThttp://terminology.hl7.org/ValueSet/v3-ActClassRecordOrganizer | |
Section.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
Section.code | example | DocumentSectionTypehttp://terminology.hl7.org/ValueSet/v3-DocumentSectionType | |
Section.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Section.entry:entry-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.entry:entry-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.entry:entry-1.typeCode | required | XActRelationshipEntryhttp://terminology.hl7.org/ValueSet/v3-xActRelationshipEntry | |
Section.component.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component:component-1.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Section.component:component-1.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor |
Id | Grade | Path(s) | Details | Requirements |
component-1 | null | Section.component:component-1 | contains IPS Translation Section 2.16.840.1.113883.10.22.3.15 (2021-09-02) : | |
entry-1 | null | Section.entry:entry-1 | contains IPS Medication Statement 2.16.840.1.113883.10.22.4.4 (2024-08-04) : |
This structure is derived from Section
Summary
Mandatory: 11 elements(1 nested mandatory element)
Must-Support: 6 elements
Fixed: 5 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: