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.16--20240612092602 | Version: 1.1.0-ballot | |||
Draft as of 2024-06-12 | Computable Name: IPSPatientStorySection | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.16 (use: official, ) |
A concise narrative from the patient’s perspective about their present health state. This is a record of the things that a person feels it is important to communicate about their needs, strengths, values, concerns and preferences to others providing support and care.
Patients unable to communicate can be supported by a proxy author. The patient’s story, provided here, may be told by the patient or by a proxy.
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.16 | |
id | S | 0..* | II | |
code | S | 1..1 | CE | |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@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 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..* | IPSTranslationSection | Base for all types and resources | |
Documentation for this format |
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) : |
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.16 | |
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
id | S | 0..* | II | |
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@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 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..* | IPSTranslationSection | Base for all types and resources | |
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 |
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) : |
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) |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
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.16 | |
@extension | 0..1 | st | ||
@ID | 0..1 | xs:ID | ||
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
@moodCode | 0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
id | S | 0..* | II | |
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
confidentialityCode | 0..1 | CE | ||
languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
subject | 0..1 | Subject | ||
author | 0..* | Author | ||
informant | 0..* | Informant | ||
entry | 0..* | Entry | ||
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:All Slices | Content/Rules for all slices | |||
@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 | 0..* | II | ||
@typeCode | 0..1 | cs | Fixed Value: COMP | |
@contextConductionInd | 0..1 | bl | Fixed Value: true | |
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) |
@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 | 0..* | II | ||
@typeCode | 0..1 | cs | Fixed Value: COMP | |
@contextConductionInd | 0..1 | bl | Fixed Value: true | |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | IPSTranslationSection | Base for all types and resources | |
Documentation for this format |
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.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) : |
This structure is derived from Section
Summary
Mandatory: 8 elements
Must-Support: 5 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 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.16 | |
id | S | 0..* | II | |
code | S | 1..1 | CE | |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@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 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..* | IPSTranslationSection | Base for all types and resources | |
Documentation for this format |
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) : |
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.16 | |
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
id | S | 0..* | II | |
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@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 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..* | IPSTranslationSection | Base for all types and resources | |
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 |
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) : |
Snapshot 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) |
@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 | ||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
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.16 | |
@extension | 0..1 | st | ||
@ID | 0..1 | xs:ID | ||
@classCode | 0..1 | cs | Binding: ActClassRecordOrganizer (required) Fixed Value: DOCSECT | |
@moodCode | 0..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |
id | S | 0..* | II | |
code | S | 1..1 | CE | Binding: DocumentSectionType (example) |
@nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | |
@code | 0..1 | cs | Fixed Value: 81338-6 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
@codeSystemName | 0..1 | st | ||
@codeSystemVersion | 0..1 | st | ||
@displayName | 0..1 | st | ||
@sdtcValueSet | 0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |
@sdtcValueSetVersion | 0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |
originalText | 0..1 | ED | ||
translation | 0..* | CD | ||
title | S | 1..1 | ST | |
text | S | 1..1 | xhtml | |
confidentialityCode | 0..1 | CE | ||
languageCode | 0..1 | CS | Binding: AllLanguages (required) | |
subject | 0..1 | Subject | ||
author | 0..* | Author | ||
informant | 0..* | Informant | ||
entry | 0..* | Entry | ||
Slices for component | 1..* | InfrastructureRoot | Slice: Unordered, Open by value:profile | |
component:All Slices | Content/Rules for all slices | |||
@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 | 0..* | II | ||
@typeCode | 0..1 | cs | Fixed Value: COMP | |
@contextConductionInd | 0..1 | bl | Fixed Value: true | |
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) |
@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 | 0..* | II | ||
@typeCode | 0..1 | cs | Fixed Value: COMP | |
@contextConductionInd | 0..1 | bl | Fixed Value: true | |
Slices for section | Content/Rules for all slices | |||
section:component-1 | 0..* | IPSTranslationSection | Base for all types and resources | |
Documentation for this format |
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.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) : |
This structure is derived from Section
Summary
Mandatory: 8 elements
Must-Support: 5 elements
Fixed: 4 elements
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices: