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: IPSCDArelatedDocument - Detailed Descriptions

Draft as of 2017-04-12

Definitions for the 2.16.840.1.113883.10.22.2.7--20170412000000 resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. RelatedDocument
Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. RelatedDocument.typeCode
Control10..1
BindingThe codes SHALL be taken from http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324The codes SHALL be taken from ParticipationType x_ActRelationshipDocumen
XML RepresentationIn the XML format, this property is represented as an attribute.
3. RelatedDocument.parentDocument
Must Supporttrue
4. RelatedDocument.parentDocument.classCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOCCLIN
5. RelatedDocument.parentDocument.moodCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. RelatedDocument.parentDocument.id
Control1..*
Must Supporttrue
7. RelatedDocument.parentDocument.code
Control0..1
Must Supporttrue
8. RelatedDocument.parentDocument.code.codeSystem
Control0..?
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.6.1
9. RelatedDocument.parentDocument.text
Control0..1
Must Supporttrue
10. RelatedDocument.parentDocument.setId
Control0..1
Must Supporttrue
11. RelatedDocument.parentDocument.versionNumber
Control0..1
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. RelatedDocument
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. RelatedDocument.typeCode
Control1..1
BindingThe codes SHALL be taken from http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 x_ActRelationshipDocumen
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. RelatedDocument.parentDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParentDocument
Must Supporttrue
4. RelatedDocument.parentDocument.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassClinicalDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
5. RelatedDocument.parentDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
6. RelatedDocument.parentDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
7. RelatedDocument.parentDocument.code
Control0..1
BindingThe codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
8. RelatedDocument.parentDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.6.1
9. RelatedDocument.parentDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
10. RelatedDocument.parentDocument.setId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
11. RelatedDocument.parentDocument.versionNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

1. RelatedDocument
Definition

Base definition for all types defined in FHIR type system.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. RelatedDocument.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. RelatedDocument.typeCode
Control1..1
BindingThe codes SHALL be taken from http://localhost:8877/fhir/ValueSet/2.16.840.1.113883.1.11.11610--20171004171324 x_ActRelationshipDocumen
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. RelatedDocument.realmCode
Definition

When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
5. RelatedDocument.typeId
Definition

When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
6. RelatedDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
7. RelatedDocument.parentDocument
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ParentDocument
Must Supporttrue
8. RelatedDocument.parentDocument.classCode
Control0..1
BindingThe codes SHALL be taken from ActClassClinicalDocument
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueDOCCLIN
Fixed ValueDOCCLIN
9. RelatedDocument.parentDocument.moodCode
Control0..1
BindingThe codes SHALL be taken from ActMood
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueEVN
Fixed ValueEVN
10. RelatedDocument.parentDocument.templateId
Definition

When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
11. RelatedDocument.parentDocument.id
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
12. RelatedDocument.parentDocument.code
Control0..1
BindingThe codes SHALL be taken from FHIRDocumentTypeCodes; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
Must Supporttrue
13. RelatedDocument.parentDocument.code.nullFlavor
Definition

If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
14. RelatedDocument.parentDocument.code.code
Definition

The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
15. RelatedDocument.parentDocument.code.codeSystem
Definition

Specifies the code system that defines the code.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed Value2.16.840.1.113883.6.1
16. RelatedDocument.parentDocument.code.codeSystemName
Definition

The common name of the coding system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
17. RelatedDocument.parentDocument.code.codeSystemVersion
Definition

If applicable, a version descriptor defined specifically for the given code system.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
18. RelatedDocument.parentDocument.code.displayName
Definition

A name or title for the code, under which the sending system shows the code value to its users.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. RelatedDocument.parentDocument.code.sdtcValueSet
Definition

The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSet.
20. RelatedDocument.parentDocument.code.sdtcValueSetVersion
Definition

The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.In the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name valueSetVersion.
21. RelatedDocument.parentDocument.code.originalText
Definition

The text or phrase used as the basis for the coding.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
22. RelatedDocument.parentDocument.code.qualifier
Definition

Specifies additional codes that increase the specificity of the the primary code.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CR
23. RelatedDocument.parentDocument.code.translation
Definition

A set of other concept descriptors that translate this concept descriptor into other code systems.

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
24. RelatedDocument.parentDocument.text
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
Must Supporttrue
25. RelatedDocument.parentDocument.setId
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
26. RelatedDocument.parentDocument.versionNumber
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/INT
Must Supporttrue