International Patient Summary 1.0.0 Release
1.0 - CI Build

International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions

Resource Profile: IPS CDA relatedDocument

Official URL: http://localhost:8877/fhir/StructureDefinition/2.16.840.1.113883.10.22.2.7--20170412000000 Version: 1.0
Draft as of 2017-04-12 Computable Name: IPSCDArelatedDocument
Other Identifiers: id: urn:oid:2.16.840.1.113883.10.22.2.7 (use: OFFICIAL)

An IPS may have three types of parent document:

  • A superseded version that the present instance of the document wholly replaces (typeCode = RPLC.html). 

  • A source document from which the present document is transformed (typeCode = XFRM.html). An IPS may be created by transformation from an already existing local Patient Summary or an IPS document. An example of this case is the creation of a derived instance in which translations are appended in order to facilitate the cross-border usage of this document; or the case in which a local patient summary is transformed to originate a new IPS instance.

  • An original version that the present document integrates (typeCode = APND.html). Some cross-border legal agreements (e.g.  the European Digital Service Infrastructure for eHealth.html) require the patient summary to be accompanied by  a printable representation of the original national data / document this IPS comes from. The relationship between the IPS and this content may be tracked using this relationship. 

Note 1: even for countries not dealing with real documents in their National Infrastructures (e.g. data collected from local databases.html), this mechanism could be useful to identify the collection of data used for generating the epSOS CDAs, facilitating the information backtracking. In that case the ID might be that of the epSOS friendly document or of any other kind of intermediate document used for generating the NCP document input. Note 2: even if none of the allowable relationships defined by the CDA standard (XFRM, RPLC, APND.html) fits perfectly with the described case; the APND relationship seems to be the one that fits the better. In fact “An addendum is a separate document that references the parent document, and may extend or alter the observations in the prior document. The parent document remains a current component of the patient record, and the addendum and its parent are both read by report recipients.”

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

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

This structure is derived from CDAR2.RelatedDocument

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... parentDocument S1..1ParentDocument
.... classCode 0..1codeFixed Value: DOCCLIN
.... moodCode 0..1codeFixed Value: EVN
.... id S1..*II
.... code S0..1CD
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... parentDocument S1..1ParentDocument
.... classCode 0..1codeBinding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
.... moodCode 0..1codeBinding: ActMood (required)
Fixed Value: EVN
.... id S1..*II
.... code S0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324
RelatedDocument.parentDocument.classCoderequiredFixed Value: DOCCLIN
RelatedDocument.parentDocument.moodCoderequiredFixed Value: EVN
RelatedDocument.parentDocument.codeextensibleFHIRDocumentTypeCodes
NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... realmCode 0..*CS
... templateId 0..*II
... parentDocument S1..1ParentDocument
.... classCode 0..1codeBinding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
.... moodCode 0..1codeBinding: ActMood (required)
Fixed Value: EVN
.... templateId 0..*II
.... id S1..*II
.... code S0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... qualifier 0..*CR
..... translation 0..*CD
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedDocument.nullFlavorrequiredNullFlavor
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324
RelatedDocument.parentDocument.classCoderequiredFixed Value: DOCCLIN
RelatedDocument.parentDocument.moodCoderequiredFixed Value: EVN
RelatedDocument.parentDocument.codeextensibleFHIRDocumentTypeCodes
RelatedDocument.parentDocument.code.nullFlavorrequiredNullFlavor

This structure is derived from CDAR2.RelatedDocument

Summary

Mandatory: 3 elements
Must-Support: 6 elements
Fixed Value: 3 elements

Differential View

This structure is derived from CDAR2.RelatedDocument

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... parentDocument S1..1ParentDocument
.... classCode 0..1codeFixed Value: DOCCLIN
.... moodCode 0..1codeFixed Value: EVN
.... id S1..*II
.... code S0..1CD
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... parentDocument S1..1ParentDocument
.... classCode 0..1codeBinding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
.... moodCode 0..1codeBinding: ActMood (required)
Fixed Value: EVN
.... id S1..*II
.... code S0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324
RelatedDocument.parentDocument.classCoderequiredFixed Value: DOCCLIN
RelatedDocument.parentDocument.moodCoderequiredFixed Value: EVN
RelatedDocument.parentDocument.codeextensibleFHIRDocumentTypeCodes

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. RelatedDocument S0..*CDAR2.RelatedDocumentBase for all types and resources
... nullFlavor 0..1codeBinding: NullFlavor (required)
... typeCode 1..1codeBinding: http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 (required): x_ActRelationshipDocument

... realmCode 0..*CS
... templateId 0..*II
... parentDocument S1..1ParentDocument
.... classCode 0..1codeBinding: ActClassClinicalDocument (required)
Fixed Value: DOCCLIN
.... moodCode 0..1codeBinding: ActMood (required)
Fixed Value: EVN
.... templateId 0..*II
.... id S1..*II
.... code S0..1CDBinding: FHIRDocumentTypeCodes (extensible)
..... nullFlavor 0..1codeBinding: NullFlavor (required)
..... code 0..1string
..... codeSystem 0..1stringFixed Value: 2.16.840.1.113883.6.1
..... codeSystemName 0..1string
..... codeSystemVersion 0..1string
..... displayName 0..1string
..... sdtcValueSet 0..1stringXML: valueSet (urn:hl7-org:sdtc)
..... sdtcValueSetVersion 0..1stringXML: valueSetVersion (urn:hl7-org:sdtc)
..... originalText 0..1ED
..... qualifier 0..*CR
..... translation 0..*CD
.... text S0..1ED
.... setId S0..1II
.... versionNumber S0..1INT

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / Code
RelatedDocument.nullFlavorrequiredNullFlavor
RelatedDocument.typeCoderequiredhttp://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324
RelatedDocument.parentDocument.classCoderequiredFixed Value: DOCCLIN
RelatedDocument.parentDocument.moodCoderequiredFixed Value: EVN
RelatedDocument.parentDocument.codeextensibleFHIRDocumentTypeCodes
RelatedDocument.parentDocument.code.nullFlavorrequiredNullFlavor

This structure is derived from CDAR2.RelatedDocument

Summary

Mandatory: 3 elements
Must-Support: 6 elements
Fixed Value: 3 elements

 

Other representations of profile: CSV, Excel, Schematron