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

Draft as of 2017-04-12

Definitions for the 2.16.840.1.113883.10.22.2.6--20170412000000 resource profile.

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

1. DocumentationOf
Definition

The documentationOf relationship in an International Patient Summary contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.

Base definition for all types defined in FHIR type system.

Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. DocumentationOf.typeCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. DocumentationOf.serviceEvent
Definition

The main activity being described by a IPS is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision.html) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range.html).

For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the low value should represent the date when the treatment relationship between the patient and the GP started; and the high value the date of the latest care event.

Must Supporttrue
4. DocumentationOf.serviceEvent.classCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePCPR
5. DocumentationOf.serviceEvent.moodCode
Control1..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueEVN
6. DocumentationOf.serviceEvent.id
Control0..*
Must Supporttrue
7. DocumentationOf.serviceEvent.effectiveTime
Control1..1
Must Supporttrue
8. DocumentationOf.serviceEvent.effectiveTime.low
Control1..1
Must Supporttrue
9. DocumentationOf.serviceEvent.effectiveTime.high
Control1..1
Must Supporttrue
10. DocumentationOf.serviceEvent.performer
Definition

It represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient’s key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors

Control0..*
Must Supporttrue
11. DocumentationOf.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer x_ServiceEventPerforme
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
12. DocumentationOf.serviceEvent.performer.functionCode
Control0..1
Must Supporttrue
13. DocumentationOf.serviceEvent.performer.time
Control0..1
Must Supporttrue
14. DocumentationOf.serviceEvent.performer.assignedEntity
Control1..1
Must Supporttrue
15. DocumentationOf.serviceEvent.performer.assignedEntity.id
Definition

Healthcare provider ID number

Control1..*
Must Supporttrue
16. DocumentationOf.serviceEvent.performer.assignedEntity.code
Definition

It describes the professional role of the healthcare provider involved in the current or pertinent historical care of the patient.

Control0..1
BindingThe codes SHALL be taken from IPS Healthcare Professional Roles; other codes may be used where these codes are not suitable IPS Healthcare Professional Role
Must Supporttrue
17. DocumentationOf.serviceEvent.performer.assignedEntity.addr
Control1..*
Must Supporttrue
18. DocumentationOf.serviceEvent.performer.assignedEntity.telecom
Control1..*
Must Supporttrue
19. DocumentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
20. DocumentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1

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

1. DocumentationOf
Definition

The documentationOf relationship in an International Patient Summary contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.

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. DocumentationOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
3. DocumentationOf.serviceEvent
Definition

The main activity being described by a IPS is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision.html) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range.html).

For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the low value should represent the date when the treatment relationship between the patient and the GP started; and the high value the date of the latest care event.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Must Supporttrue
4. DocumentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueACT
Fixed ValuePCPR
5. DocumentationOf.serviceEvent.moodCode
Control1..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. DocumentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
7. DocumentationOf.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Must Supporttrue
8. DocumentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
9. DocumentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
10. DocumentationOf.serviceEvent.performer
Definition

It represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient’s key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Must Supporttrue
11. DocumentationOf.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer x_ServiceEventPerforme
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
12. DocumentationOf.serviceEvent.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
13. DocumentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Must Supporttrue
14. DocumentationOf.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Must Supporttrue
15. DocumentationOf.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
16. DocumentationOf.serviceEvent.performer.assignedEntity.id
Definition

Healthcare provider ID number

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
17. DocumentationOf.serviceEvent.performer.assignedEntity.code
Definition

It describes the professional role of the healthcare provider involved in the current or pertinent historical care of the patient.

Control0..1
BindingThe codes SHALL be taken from IPS Healthcare Professional Roles; other codes may be used where these codes are not suitable IPS Healthcare Professional Role
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
18. DocumentationOf.serviceEvent.performer.assignedEntity.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
19. DocumentationOf.serviceEvent.performer.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
20. DocumentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
21. DocumentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization

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

1. DocumentationOf
Definition

The documentationOf relationship in an International Patient Summary contains the representation of providers who are wholly or partially responsible for the safety and well-being of a subject of care.

Control0..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. DocumentationOf.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. DocumentationOf.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
4. DocumentationOf.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. DocumentationOf.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. DocumentationOf.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. DocumentationOf.serviceEvent
Definition

The main activity being described by a IPS is the provision of healthcare over a period of time. This is shown by setting the value of serviceEvent/@classCode to “PCPR” (care provision.html) and indicating the duration over which care was provided in serviceEvent/effectiveTime. Additional data from outside this duration may also be included if it is relevant to care provided during that time range (e.g., reviewed during the stated time range.html).

For example if the IPS is generated by a GP based on information recorded in his/her EHR-S, then the low value should represent the date when the treatment relationship between the patient and the GP started; and the high value the date of the latest care event.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ServiceEvent
Must Supporttrue
8. DocumentationOf.serviceEvent.classCode
Control1..1
BindingThe codes SHALL be taken from ActClass
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueACT
Fixed ValuePCPR
9. DocumentationOf.serviceEvent.moodCode
Control1..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. DocumentationOf.serviceEvent.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. DocumentationOf.serviceEvent.id
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
12. DocumentationOf.serviceEvent.code
Definition

Drawn from concept domain ActCode

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
13. DocumentationOf.serviceEvent.effectiveTime
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Must Supporttrue
14. DocumentationOf.serviceEvent.effectiveTime.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.
15. DocumentationOf.serviceEvent.effectiveTime.value
Definition

A quantity specifying a point on the axis of natural time. A point in time is most often represented as a calendar expression.

Control0..1
TypedateTime
XML RepresentationIn the XML format, this property is represented as an attribute.
16. DocumentationOf.serviceEvent.effectiveTime.inclusive
Definition

Specifies whether the limit is included in the interval (interval is closed) or excluded from the interval (interval is open).

Control0..1
Typeboolean
XML RepresentationIn the XML format, this property is represented as an attribute.
17. DocumentationOf.serviceEvent.effectiveTime.operator
Definition

A code specifying whether the set component is included (union) or excluded (set-difference) from the set, or other set operations with the current set component and the set as constructed from the representation stream up to the current point.

Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
18. DocumentationOf.serviceEvent.effectiveTime.low
Definition

This is the low limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
19. DocumentationOf.serviceEvent.effectiveTime.high
Definition

This is the high limit of the interval.

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
20. DocumentationOf.serviceEvent.effectiveTime.width
Definition

The difference between high and low boundary. The purpose of distinguishing a width property is to handle all cases of incomplete information symmetrically. In any interval representation only two of the three properties high, low, and width need to be stated and the third can be derived.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/PQ
21. DocumentationOf.serviceEvent.effectiveTime.center
Definition

The arithmetic mean of the interval (low plus high divided by 2). The purpose of distinguishing the center as a semantic property is for conversions of intervals from and to point values.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
22. DocumentationOf.serviceEvent.performer
Definition

It represents the healthcare providers involved in the current or pertinent historical care of the patient. Preferably, the patient’s key healthcare providers would be listed, particularly their primary physician and any active consulting physicians, therapists, and counselors

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/Performer1
Must Supporttrue
23. DocumentationOf.serviceEvent.performer.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.
24. DocumentationOf.serviceEvent.performer.typeCode
Control1..1
BindingThe codes SHALL be taken from x_ServiceEventPerformer x_ServiceEventPerforme
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueDOC
25. DocumentationOf.serviceEvent.performer.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
26. DocumentationOf.serviceEvent.performer.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
27. DocumentationOf.serviceEvent.performer.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
28. DocumentationOf.serviceEvent.performer.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
29. DocumentationOf.serviceEvent.performer.time
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
Must Supporttrue
30. DocumentationOf.serviceEvent.performer.assignedEntity
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Must Supporttrue
31. DocumentationOf.serviceEvent.performer.assignedEntity.classCode
Control1..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValueASSIGNED
32. DocumentationOf.serviceEvent.performer.assignedEntity.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
33. DocumentationOf.serviceEvent.performer.assignedEntity.id
Definition

Healthcare provider ID number

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
34. DocumentationOf.serviceEvent.performer.assignedEntity.sdtcIdentifiedBy
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:sdtc.In the XML format, this property has the actual name identifiedBy.
35. DocumentationOf.serviceEvent.performer.assignedEntity.code
Definition

It describes the professional role of the healthcare provider involved in the current or pertinent historical care of the patient.

Control0..1
BindingThe codes SHALL be taken from IPS Healthcare Professional Roles; other codes may be used where these codes are not suitable IPS Healthcare Professional Role
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
36. DocumentationOf.serviceEvent.performer.assignedEntity.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
37. DocumentationOf.serviceEvent.performer.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
38. DocumentationOf.serviceEvent.performer.assignedEntity.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
39. DocumentationOf.serviceEvent.performer.assignedEntity.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization