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.22--20170405000000 | Version: 1.1.0-ballot | |||
Draft as of 2017-04-05 | Computable Name: IPSCommentActivity | |||
Other Identifiers: OID:2.16.840.1.113883.10.22.4.22 (use: official, ) |
Comments are free text data that cannot otherwise be recorded using data elements already defined by this specification. They are not to be used to record information that can be recorded elsewhere. For example, a free text description of the severity of an allergic reaction would not be recorded in a comment.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 0..* | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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) | |
@classCode | 1..1 | code | Fixed Value: ACT | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
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.22 | |
code | S | 1..1 | CD | |
@code | 0..1 | cs | Fixed Value: 48767-8 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
text | S | 1..1 | ED | |
reference | SC | 1..1 | TEL | PD4012N3l16l262l20l14l9l11: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) |
@value | 1..1 | url | ||
author | 0..1 | Author | ||
time | S | 1..1 | TS | |
assignedAuthor | S | 1..1 | AssignedAuthor | |
id | S | 1..1 | II | |
addr | S | 1..* | AD | |
name | S | 0..* | ||
softwareName | S | 0..1 | ||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 0..* | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.22 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) | |
code | S | 1..1 | CD | Binding: v3 Code System ActCode (example) |
@code | 0..1 | cs | Fixed Value: 48767-8 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
text | S | 1..1 | ED | |
reference | SC | 1..1 | TEL | PD4012N3l16l262l20l14l9l11: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) |
@value | 1..1 | url | ||
author | 0..1 | Author | ||
time | S | 1..1 | TS | |
assignedAuthor | S | 1..1 | AssignedAuthor | |
id | S | 1..1 | II | |
addr | S | 1..* | AD | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Act.classCode | required | XActClassDocumentEntryActhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | XDocumentActMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | XActClassDocumentEntryActhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | XDocumentActMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.text.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.reference.use | required | TelecommunicationAddressUsehttp://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Act.author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Act.author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Act.author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Act.author.assignedAuthor.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |
Differential View
This structure is derived from Act
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 0..* | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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) | |
@classCode | 1..1 | code | Fixed Value: ACT | |
@moodCode | 1..1 | code | Fixed Value: EVN | |
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.22 | |
code | S | 1..1 | CD | |
@code | 0..1 | cs | Fixed Value: 48767-8 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
text | S | 1..1 | ED | |
reference | SC | 1..1 | TEL | PD4012N3l16l262l20l14l9l11: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) |
@value | 1..1 | url | ||
author | 0..1 | Author | ||
time | S | 1..1 | TS | |
assignedAuthor | S | 1..1 | AssignedAuthor | |
id | S | 1..1 | II | |
addr | S | 1..* | AD | |
name | S | 0..* | ||
softwareName | S | 0..1 | ||
Documentation for this format |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |
Key Elements View
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Act | 0..* | Act | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, @negationInd, id, code, text, statusCode, effectiveTime, priorityCode, languageCode, 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.22 | |
@classCode | 1..1 | cs | Binding: XActClassDocumentEntryAct (2.0.0) (required) | |
@moodCode | 1..1 | cs | Binding: XDocumentActMood (2.0.0) (required) | |
code | S | 1..1 | CD | Binding: v3 Code System ActCode (example) |
@code | 0..1 | cs | Fixed Value: 48767-8 | |
@codeSystem | 0..1 | oid, uuid, ruid | Fixed Value: 2.16.840.1.113883.6.1 | |
text | S | 1..1 | ED | |
reference | SC | 1..1 | TEL | PD4012N3l16l262l20l14l9l11: This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) |
@value | 1..1 | url | ||
author | 0..1 | Author | ||
time | S | 1..1 | TS | |
assignedAuthor | S | 1..1 | AssignedAuthor | |
id | S | 1..1 | II | |
addr | S | 1..* | AD | |
Documentation for this format |
Path | Conformance | ValueSet | URI |
Act.classCode | required | XActClassDocumentEntryActhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | XDocumentActMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |
Snapshot View
Path | Conformance | ValueSet / Code | URI |
Act.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.templateId:primary.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.classCode | required | XActClassDocumentEntryActhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryAct|2.0.0 | |
Act.moodCode | required | XDocumentActMoodhttp://terminology.hl7.org/ValueSet/v3-xDocumentActMood|2.0.0 | |
Act.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
Act.code.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
Act.text.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
Act.text.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
Act.text.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
Act.text.reference.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.text.reference.use | required | TelecommunicationAddressUsehttp://terminology.hl7.org/ValueSet/v3-TelecommunicationAddressUse|2.0.0 | |
Act.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
Act.priorityCode | example | ActPriorityhttp://terminology.hl7.org/ValueSet/v3-ActPriority | |
Act.languageCode | required | AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages | |
Act.author.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.typeCode | required | Fixed Value: AUThttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
Act.author.contextControlCode | required | Fixed Value: OPhttp://hl7.org/cda/stds/core/ValueSet/CDAContextControl | |
Act.author.assignedAuthor.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
Act.author.assignedAuthor.classCode | required | Fixed Value: ASSIGNEDhttp://terminology.hl7.org/ValueSet/v3-RoleClassAssignedEntity | |
Act.author.assignedAuthor.code | example | CDARoleCodehttp://hl7.org/cda/stds/core/ValueSet/CDARoleCode |
Id | Grade | Path(s) | Details | Requirements |
PD4012N3l16l262l20l14l9l11 | error | Act.text.reference | This reference/@value SHALL begin with a '#' and SHALL point to its corresponding narrative (using the approach defined in CDA Release 2, section 4.3.5.1) : |