International Patient Summary 1.0.0 Release - Local Development build (v1.0). See the Directory of published versions
Draft as of 2017-04-11 |
Definitions for the 2.16.840.1.113883.10.22.2.2--20170411000000 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. Author | |
Control | 1..*1 |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Author.typeCode | |
XML Representation | In the XML format, this property is represented as an attribute. |
3. Author.contextControlCode | |
XML Representation | In the XML format, this property is represented as an attribute. |
4. Author.functionCode | |
Must Support | true |
5. Author.time | |
Definition | The author/time element represents the start time of the author’s participation in the creation of the clinical document. |
Must Support | true |
6. Author.assignedAuthor | |
Must Support | true |
7. Author.assignedAuthor.determinerCode | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
8. Author.assignedAuthor.name | |
Definition | Name of the person (e.g. the Healthcare Professional.html) authoring this document |
Control | 1..* |
Must Support | true |
9. Author.assignedAuthor.name.family | |
Control | 1..* |
Must Support | true |
10. Author.assignedAuthor.name.given | |
Control | 1..* |
Must Support | true |
11. Author.assignedAuthor.classCode | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | PSN |
12. Author.assignedAuthor.id | |
Definition | Author Identifier(s.html) |
Control | 1..* |
Must Support | true |
13. Author.assignedAuthor.id.nullFlavor | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
14. Author.assignedAuthor.code | |
Definition | A code, which identifies the profession/competence/specialty of the author when it is a person. |
Control | 0..1 |
Binding | The 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 Support | true |
15. Author.assignedAuthor.addr | |
Control | 1..* |
Must Support | true |
16. Author.assignedAuthor.telecom | |
Control | 1..* |
Must Support | true |
17. Author.assignedAuthor.telecom.value | |
Control | 0..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
18. Author.assignedAuthor.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. |
19. Author.assignedAuthor.representedOrganization | |
Control | 0..1 |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. Author | |
Definition | Base definition for all types defined in FHIR type system. |
Control | 10..* |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Author.typeCode | |
Control | 0..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 | AUT |
3. Author.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 |
4. Author.functionCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Must Support | true |
5. Author.time | |
Definition | The author/time element represents the start time of the author’s participation in the creation of the clinical document. |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
Must Support | true |
6. Author.assignedAuthor | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
Must Support | true |
7. Author.assignedAuthor.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from RoleClassAssignedEntity |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | ASSIGNED |
Fixed Value | PSN |
8. Author.assignedAuthor.id | |
Definition | Author Identifier(s.html) |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
9. Author.assignedAuthor.id.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. Author.assignedAuthor.code | |
Definition | A code, which identifies the profession/competence/specialty of the author when it is a person. |
Control | 0..1 |
Binding | The codes SHALL be taken from IPS Healthcare Professional Roles; other codes may be used where these codes are not suitable IPS Healthcare Professional Role |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Must Support | true |
11. Author.assignedAuthor.addr | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
Must Support | true |
12. Author.assignedAuthor.telecom | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
Must Support | true |
13. Author.assignedAuthor.telecom.value | |
Control | 0..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
14. Author.assignedAuthor.telecom.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
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. |
15. Author.assignedAuthor.representedOrganization | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. Author | |
Definition | Base definition for all types defined in FHIR type system. |
Control | 1..* |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. Author.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. Author.typeCode | |
Control | 0..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 | AUT |
4. Author.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. Author.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. Author.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. Author.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 |
8. Author.functionCode | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Must Support | true |
9. Author.time | |
Definition | The author/time element represents the start time of the author’s participation in the creation of the clinical document. |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
Must Support | true |
10. Author.assignedAuthor | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor |
Must Support | true |
11. Author.assignedAuthor.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from RoleClassAssignedEntity |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | ASSIGNED |
Fixed Value | PSN |
12. Author.assignedAuthor.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 |
13. Author.assignedAuthor.id | |
Definition | Author Identifier(s.html) |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
14. Author.assignedAuthor.id.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. |
15. Author.assignedAuthor.id.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. |
16. Author.assignedAuthor.id.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. |
17. Author.assignedAuthor.id.root | |
Definition | A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
18. Author.assignedAuthor.id.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. |
19. Author.assignedAuthor.sdtcIdentifiedBy | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/IdentifiedBy |
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 identifiedBy . |
20. Author.assignedAuthor.code | |
Definition | A code, which identifies the profession/competence/specialty of the author when it is a person. |
Control | 0..1 |
Binding | The codes SHALL be taken from IPS Healthcare Professional Roles; other codes may be used where these codes are not suitable IPS Healthcare Professional Role |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
Must Support | true |
21. Author.assignedAuthor.addr | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
Must Support | true |
22. Author.assignedAuthor.telecom | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
Must Support | true |
23. Author.assignedAuthor.telecom.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. |
24. Author.assignedAuthor.telecom.value | |
Control | 0..1 |
Type | uri |
XML Representation | In the XML format, this property is represented as an attribute. |
25. Author.assignedAuthor.telecom.useablePeriod | |
Definition | Specifies the periods of time during which the telecommunication address can be used. For a telephone number, this can indicate the time of day in which the party can be reached on that telephone. For a web address, it may specify a time range in which the web content is promised to be available under the given address. |
Control | 0..* |
Type | Choice of: http://hl7.org/fhir/cda/StructureDefinition/IVL-TS, http://hl7.org/fhir/cda/StructureDefinition/EIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/PIVL-TS, http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
Default Type | http://hl7.org/fhir/cda/StructureDefinition/SXPR-TS |
XML Representation | The type of this property is determined using the xsi:type attribute. |
26. Author.assignedAuthor.telecom.use | |
Definition | One or more codes advising a system or user which telecommunication address in a set of like addresses to select for a given telecommunication need. |
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. |
27. Author.assignedAuthor.assignedPerson | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
28. Author.assignedAuthor.assignedAuthoringDevice | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice |
29. Author.assignedAuthor.representedOrganization | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
Must Support | true |