International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions
Draft as of 2017-04-12 |
Definitions for the 2.16.840.1.113883.10.22.2.5--20170412000000 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Participant2 | |
Definition | Patient contacts or the Preferred Health Professional to contact in case of emergency. Base definition for all types defined in FHIR type system. |
Control | 1..*1 |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Participant2.functionCode | |
Definition | The element may be used to indicate that this participant is the preferred Health Professional to contact in case of emergency. |
Control | 0..1 |
3. Participant2.functionCode.code | |
Control | 0..? |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | PCP |
4. Participant2.functionCode.codeSystem | |
Control | 0..? |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.5.88 |
5. Participant2.associatedEntity | |
Definition | The element identifies the type of contact. |
Control | 0..* |
Must Support | true |
6. Participant2.associatedEntity.classCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from INDRoleclassCodes INDRoleclassCode |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
7. Participant2.associatedEntity.code | |
Definition | This element indicates the relationship between the patient and this participant. |
Control | 0..1 |
Binding | The codes SHALL be taken from IPS Healthcare Professional Roles IPS Healthcare Professional Role |
Must Support | true |
8. Participant2.associatedEntity.addr | |
Definition | Patient Contact's / Preferred HP's Address |
Control | 1..* This element is affected by the following invariants: PD6643N3l24l94l26l15l13l10 |
Must Support | true |
Invariants | Defined on this element PD6643N3l24l94l26l15l13l10: If addr is not nullflavored at least one sub element has to be provided (: null) |
9. Participant2.associatedEntity.addr.use | |
Control | 0..1 |
Binding | The codes SHALL be taken from PostalAddressUse PostalAddressUs |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
10. Participant2.associatedEntity.addr.nullFlavor | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | NI |
11. Participant2.associatedEntity.addr.streetAddressLine | |
Definition | Subject's or Organization's Street Address Line |
Control | 0..* |
12. Participant2.associatedEntity.addr.city | |
Definition | Subject's or Organization's City |
Control | 0..1 |
13. Participant2.associatedEntity.addr.postalCode | |
Definition | Subject's or Organization's Postal Code |
Control | 0..1 |
14. Participant2.associatedEntity.addr.state | |
Definition | Subject's or Organization's State or Province |
Control | 0..1 |
15. Participant2.associatedEntity.addr.country | |
Definition | Subject's Country.The content of this element SHALL be selected EITHER from ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300 DYNAMIC OR MAY be selected from ISO Country Alpha-3 2.16.840.1.113883.1.11.171 DYNAMIC, IF the country is not specified in ValueSet ISO Country Alpha-2 urn:oid:2.16.840.1.113883.1.11.20300. |
Control | 0..1 |
16. Participant2.associatedEntity.telecom | |
Definition | Patient Contact's / Preferred HP's/Legal Organization telephone or e-mail element is required.If there is no information, the nullFlavor attribute shall have a value of 'NI' and the "value" and "use" attributes shall be omitted, otherwise the nullFlavor attribute shall not be present, and the "value" and "use" attributes shall be present |
Control | 1..* |
Must Support | true |
17. Participant2.associatedEntity.telecom.use | |
Control | 0..1 |
Binding | The codes SHALL be taken from TelecommunicationAddressUse TelecommunicationAddressUs |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
18. Participant2.associatedEntity.telecom.nullFlavor | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | NI |
19. Participant2.associatedEntity.name | |
Definition | Patient Contact's Name / Preferred HP's Name |
Control | 1..* |
Must Support | true |
20. Participant2.associatedEntity.name.family | |
Definition | Patient Contact's Family Name/Surname / Preferred HP's Family Name/Surname |
Control | 1..* |
Must Support | true |
21. Participant2.associatedEntity.name.given | |
Definition | Patient Contact's Given Name / Preferred HP's Given Name |
Control | 1..* |
Must Support | true |
22. Participant2.associatedEntity.name | |
Definition | Organization's Name |
Control | 1..* |
Must Support | true |
23. Participant2.typeCode | |
Control | 10..1 |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | IND |
24. Participant2.templateId | |
Slicing | This element introduces a set of slices on Participant2.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
25. Participant2.templateId:primary | |
SliceName | primary |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
26. Participant2.templateId:primary.root | |
Control | 1..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.2.5 |
Guidance on how to interpret the contents of this table can be found here.
1. Participant2 | |
Definition | Patient contacts or the Preferred Health Professional to contact in case of emergency. Base definition for all types defined in FHIR type system. |
Control | 0..* |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Participant2.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | IND |
3. Participant2.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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Slicing | This element introduces a set of slices on Participant2.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
4. Participant2.templateId:primary | |
SliceName | primary |
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 |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
5. Participant2.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.2.5 |
6. Participant2.participantRole | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole |
Guidance on how to interpret the contents of this table can be found here.
1. Participant2 | |
Definition | Patient contacts or the Preferred Health Professional to contact in case of emergency. |
Control | 0..* |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Participant2.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
3. Participant2.typeCode | |
Control | 1..1 |
Binding | The codes SHALL be taken from ParticipationType |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | IND |
4. Participant2.contextControlCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from ContextControl |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | OP |
5. Participant2.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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
6. Participant2.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. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
7. Participant2.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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Slicing | This element introduces a set of slices on Participant2.templateId. The slices are unordered and Open, and can be differentiated using the following discriminators:
|
8. Participant2.templateId:primary | |
SliceName | primary |
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 |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
9. Participant2.templateId:primary.nullFlavor | |
Definition | If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing. |
Control | 0..1 |
Binding | The codes SHALL be taken from NullFlavor |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
10. Participant2.templateId:primary.assigningAuthorityName | |
Definition | A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
11. Participant2.templateId:primary.displayable | |
Definition | Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false). |
Control | 0..1 |
Type | boolean |
XML Representation | In the XML format, this property is represented as an attribute. |
12. Participant2.templateId:primary.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 1..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | 2.16.840.1.113883.10.22.2.5 |
13. Participant2.templateId:primary.extension | |
Definition | A character string as a unique identifier within the scope of the identifier root. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
14. Participant2.sdtcFunctionCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:sdtc .In the XML format, this property has the actual name functionCode . |
15. Participant2.time | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
16. Participant2.awarenessCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
17. Participant2.participantRole | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ParticipantRole |