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.4--20170411000000 resource profile.
Guidance on how to interpret the contents of this table can be found here.
1. LegalAuthenticator | |
Control | 1..*1 |
Must Support | true |
XML Representation | In the XML format, this property has the namespace urn:hl7-org:v3 . |
2. LegalAuthenticator.time | |
Definition | Time of signing the document |
Must Support | true |
3. LegalAuthenticator.signatureCode | |
Definition | Signature code |
Must Support | true |
4. LegalAuthenticator.signatureCode.code | |
Control | 0..? |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | S |
5. LegalAuthenticator.assignedEntity | |
Definition | The entity that is responsible for the legal authentication of the CDA document |
Must Support | true |
6. LegalAuthenticator.assignedEntity.id | |
Definition | Unique identification of legal authenticator |
Control | 1..* |
Must Support | true |
7. LegalAuthenticator.assignedEntity.addr | |
Control | 1..* |
Must Support | true |
8. LegalAuthenticator.assignedEntity.telecom | |
Control | 1..* |
Must Support | true |
9. LegalAuthenticator.assignedEntity.assignedPerson | |
Control | 1..1 |
Must Support | true |
10. LegalAuthenticator.assignedEntity.assignedPerson.classCode | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | PSN |
11. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode | |
Control | 0..1 |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | INSTANCE |
12. LegalAuthenticator.assignedEntity.assignedPerson.name | |
Definition | Name of the legal authenticator |
Control | 1..* |
Must Support | true |
13. LegalAuthenticator.assignedEntity.assignedPerson.name.family | |
Definition | HP Family Name/Surname |
Control | 1..* |
Must Support | true |
14. LegalAuthenticator.assignedEntity.assignedPerson.name.given | |
Definition | HP Given Name |
Control | 1..* |
Must Support | true |
15. LegalAuthenticator.assignedEntity.representedOrganization | |
Definition | Organization the legal authenticator is acting for |
Control | 1..1 |
Must Support | true |
Guidance on how to interpret the contents of this table can be found here.
1. LegalAuthenticator | |
Definition | 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. LegalAuthenticator.time | |
Definition | Time of signing the document |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
Must Support | true |
3. LegalAuthenticator.signatureCode | |
Definition | Signature code |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
Must Support | true |
4. LegalAuthenticator.signatureCode.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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | S |
5. LegalAuthenticator.signatureCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
6. LegalAuthenticator.signatureCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
7. LegalAuthenticator.signatureCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
8. LegalAuthenticator.signatureCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
9. LegalAuthenticator.signatureCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
10. LegalAuthenticator.signatureCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
11. LegalAuthenticator.signatureCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
XML Representation | The type of this property is determined using the xsi:type attribute. |
12. LegalAuthenticator.assignedEntity | |
Definition | The entity that is responsible for the legal authentication of the CDA document |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
Must Support | true |
13. LegalAuthenticator.assignedEntity.classCode | |
Control | 1..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 | ASSIGNED |
14. LegalAuthenticator.assignedEntity.id | |
Definition | Unique identification of legal authenticator |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
15. LegalAuthenticator.assignedEntity.addr | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
Must Support | true |
16. LegalAuthenticator.assignedEntity.telecom | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
Must Support | true |
17. LegalAuthenticator.assignedEntity.assignedPerson | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
Must Support | true |
18. LegalAuthenticator.assignedEntity.assignedPerson.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityClassLivingSubject |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | PSN |
Fixed Value | PSN |
19. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminer |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | INSTANCE |
Fixed Value | INSTANCE |
20. LegalAuthenticator.assignedEntity.assignedPerson.name | |
Definition | Name of the legal authenticator A name associated with the person. |
Control | 10..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENHumanName |
Must Support | true |
Requirements | Need to be able to track the person by multiple names. Examples are your official name and a partner name. |
Comments | Person may have multiple names with different uses or applicable periods. |
21. LegalAuthenticator.assignedEntity.assignedPerson.name.family | |
Definition | HP Family Name/Surname |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Must Support | true |
22. LegalAuthenticator.assignedEntity.assignedPerson.name.given | |
Definition | HP Given Name |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Must Support | true |
23. LegalAuthenticator.assignedEntity.representedOrganization | |
Definition | Organization the legal authenticator is acting for |
Control | 1..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. LegalAuthenticator | |
Definition | 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. LegalAuthenticator.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. LegalAuthenticator.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 | LA |
4. LegalAuthenticator.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. LegalAuthenticator.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. LegalAuthenticator.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. LegalAuthenticator.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. LegalAuthenticator.time | |
Definition | Time of signing the document |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/TS |
Must Support | true |
9. LegalAuthenticator.signatureCode | |
Definition | Signature code |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CS |
Must Support | true |
10. LegalAuthenticator.signatureCode.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. |
11. LegalAuthenticator.signatureCode.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. |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
Fixed Value | S |
12. LegalAuthenticator.signatureCode.codeSystem | |
Definition | Specifies the code system that defines the code. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
13. LegalAuthenticator.signatureCode.codeSystemName | |
Definition | The common name of the coding system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
14. LegalAuthenticator.signatureCode.codeSystemVersion | |
Definition | If applicable, a version descriptor defined specifically for the given code system. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
15. LegalAuthenticator.signatureCode.displayName | |
Definition | A name or title for the code, under which the sending system shows the code value to its users. |
Control | 0..0 |
Type | string |
XML Representation | In the XML format, this property is represented as an attribute. |
16. LegalAuthenticator.signatureCode.sdtcValueSet | |
Definition | The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept. |
Control | 0..1 |
Type | string |
XML Representation | In 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 . |
17. LegalAuthenticator.signatureCode.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. |
Control | 0..1 |
Type | string |
XML Representation | In 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 . |
18. LegalAuthenticator.signatureCode.originalText | |
Definition | The text or phrase used as the basis for the coding. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
19. LegalAuthenticator.signatureCode.qualifier | |
Definition | Specifies additional codes that increase the specificity of the the primary code. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CR |
20. LegalAuthenticator.signatureCode.translation | |
Definition | A set of other concept descriptors that translate this concept descriptor into other code systems. |
Control | 0..0 |
Type | http://hl7.org/fhir/cda/StructureDefinition/CD |
XML Representation | The type of this property is determined using the xsi:type attribute. |
21. LegalAuthenticator.sdtcSignatureText | |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/ED |
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 signatureText . |
22. LegalAuthenticator.assignedEntity | |
Definition | The entity that is responsible for the legal authentication of the CDA document |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/AssignedEntity |
Must Support | true |
23. LegalAuthenticator.assignedEntity.classCode | |
Control | 1..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 | ASSIGNED |
24. LegalAuthenticator.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 |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
25. LegalAuthenticator.assignedEntity.id | |
Definition | Unique identification of legal authenticator |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/II |
Must Support | true |
26. LegalAuthenticator.assignedEntity.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 . |
27. LegalAuthenticator.assignedEntity.code | |
Control | 0..1 |
Binding | The codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable |
Type | http://hl7.org/fhir/cda/StructureDefinition/CE |
28. LegalAuthenticator.assignedEntity.addr | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/AD |
Must Support | true |
29. LegalAuthenticator.assignedEntity.telecom | |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/TEL |
Must Support | true |
30. LegalAuthenticator.assignedEntity.assignedPerson | |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Person |
Must Support | true |
31. LegalAuthenticator.assignedEntity.assignedPerson.classCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityClassLivingSubject |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | PSN |
Fixed Value | PSN |
32. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode | |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityDeterminer |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
Default Value | INSTANCE |
Fixed Value | INSTANCE |
33. LegalAuthenticator.assignedEntity.assignedPerson.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 |
34. LegalAuthenticator.assignedEntity.assignedPerson.name | |
Definition | Name of the legal authenticator |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/EN |
Must Support | true |
35. LegalAuthenticator.assignedEntity.assignedPerson.name.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. |
36. LegalAuthenticator.assignedEntity.assignedPerson.name.use | |
Definition | A set of codes advising a system or user which name in a set of like names to select for a given purpose. A name without specific use code might be a default name useful for any purpose, but a name with a specific use code would be preferred for that respective purpose |
Control | 0..1 |
Binding | The codes SHALL be taken from EntityNameUse |
Type | code |
XML Representation | In the XML format, this property is represented as an attribute. |
37. LegalAuthenticator.assignedEntity.assignedPerson.name.delimiter | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
38. LegalAuthenticator.assignedEntity.assignedPerson.name.family | |
Definition | HP Family Name/Surname |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Must Support | true |
39. LegalAuthenticator.assignedEntity.assignedPerson.name.given | |
Definition | HP Given Name |
Control | 1..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
Must Support | true |
40. LegalAuthenticator.assignedEntity.assignedPerson.name.prefix | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
41. LegalAuthenticator.assignedEntity.assignedPerson.name.suffix | |
Control | 0..* |
Type | http://hl7.org/fhir/cda/StructureDefinition/ENXP |
42. LegalAuthenticator.assignedEntity.assignedPerson.name.other | |
Control | 0..1 |
Type | string |
XML Representation | In the XML format, this property is represented as unadorned text. |
43. LegalAuthenticator.assignedEntity.assignedPerson.name.validTime | |
Definition | An interval of time specifying the time during which the name is or was used for the entity. This accomodates the fact that people change names for people, places and things. |
Control | 0..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/IVL-TS |
44. LegalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship | |
Control | 0..* |
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 asPatientRelationship . |
45. LegalAuthenticator.assignedEntity.representedOrganization | |
Definition | Organization the legal authenticator is acting for |
Control | 1..1 |
Type | http://hl7.org/fhir/cda/StructureDefinition/Organization |
Must Support | true |