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

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
Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. LegalAuthenticator.time
Definition

Time of signing the document

Must Supporttrue
3. LegalAuthenticator.signatureCode
Definition

Signature code

Must Supporttrue
4. LegalAuthenticator.signatureCode.code
Control0..?
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueS
5. LegalAuthenticator.assignedEntity
Definition

The entity that is responsible for the legal authentication of the CDA document

Must Supporttrue
6. LegalAuthenticator.assignedEntity.id
Definition

Unique identification of legal authenticator

Control1..*
Must Supporttrue
7. LegalAuthenticator.assignedEntity.addr
Control1..*
Must Supporttrue
8. LegalAuthenticator.assignedEntity.telecom
Control1..*
Must Supporttrue
9. LegalAuthenticator.assignedEntity.assignedPerson
Control1..1
Must Supporttrue
10. LegalAuthenticator.assignedEntity.assignedPerson.classCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePSN
11. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
12. LegalAuthenticator.assignedEntity.assignedPerson.name
Definition

Name of the legal authenticator

Control1..*
Must Supporttrue
13. LegalAuthenticator.assignedEntity.assignedPerson.name.family
Definition

HP Family Name/Surname

Control1..*
Must Supporttrue
14. LegalAuthenticator.assignedEntity.assignedPerson.name.given
Definition

HP Given Name

Control1..*
Must Supporttrue
15. LegalAuthenticator.assignedEntity.representedOrganization
Definition

Organization the legal authenticator is acting for

Control1..1
Must Supporttrue

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.

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

Time of signing the document

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
3. LegalAuthenticator.signatureCode
Definition

Signature code

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueS
5. LegalAuthenticator.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
6. LegalAuthenticator.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn 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.

Control0..0
Typestring
XML RepresentationIn 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.

Control0..0
Typestring
XML RepresentationIn 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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
10. LegalAuthenticator.signatureCode.qualifier
Definition

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

Control0..0
Typehttp://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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe 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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Must Supporttrue
13. LegalAuthenticator.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
14. LegalAuthenticator.assignedEntity.id
Definition

Unique identification of legal authenticator

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
15. LegalAuthenticator.assignedEntity.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
16. LegalAuthenticator.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
17. LegalAuthenticator.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Must Supporttrue
18. LegalAuthenticator.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
19. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
20. LegalAuthenticator.assignedEntity.assignedPerson.name
Definition

Name of the legal authenticator

A name associated with the person.

Control10..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENHumanName
Must Supporttrue
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

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
Must Supporttrue
22. LegalAuthenticator.assignedEntity.assignedPerson.name.given
Definition

HP Given Name

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
Must Supporttrue
23. LegalAuthenticator.assignedEntity.representedOrganization
Definition

Organization the legal authenticator is acting for

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Must Supporttrue

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.

Control0..*
Must Supporttrue
XML RepresentationIn 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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. LegalAuthenticator.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueLA
4. LegalAuthenticator.contextControlCode
Control0..1
BindingThe codes SHALL be taken from ContextControl
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueOP
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

Control0..*
Typehttp://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.

Control0..1
Typehttp://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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
8. LegalAuthenticator.time
Definition

Time of signing the document

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
9. LegalAuthenticator.signatureCode
Definition

Signature code

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CS
Must Supporttrue
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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn 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.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueS
12. LegalAuthenticator.signatureCode.codeSystem
Definition

Specifies the code system that defines the code.

Control0..0
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
13. LegalAuthenticator.signatureCode.codeSystemName
Definition

The common name of the coding system.

Control0..0
Typestring
XML RepresentationIn 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.

Control0..0
Typestring
XML RepresentationIn 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.

Control0..0
Typestring
XML RepresentationIn 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.

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.
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.

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.
18. LegalAuthenticator.signatureCode.originalText
Definition

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

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
19. LegalAuthenticator.signatureCode.qualifier
Definition

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

Control0..0
Typehttp://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.

Control0..0
Typehttp://hl7.org/fhir/cda/StructureDefinition/CD
XML RepresentationThe type of this property is determined using the xsi:type attribute.
21. LegalAuthenticator.sdtcSignatureText
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/ED
XML RepresentationIn 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

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedEntity
Must Supporttrue
23. LegalAuthenticator.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
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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
25. LegalAuthenticator.assignedEntity.id
Definition

Unique identification of legal authenticator

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
Must Supporttrue
26. LegalAuthenticator.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.
27. LegalAuthenticator.assignedEntity.code
Control0..1
BindingThe codes SHALL be taken from v3 Code System RoleCode; other codes may be used where these codes are not suitable
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
28. LegalAuthenticator.assignedEntity.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
29. LegalAuthenticator.assignedEntity.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
30. LegalAuthenticator.assignedEntity.assignedPerson
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
Must Supporttrue
31. LegalAuthenticator.assignedEntity.assignedPerson.classCode
Control0..1
BindingThe codes SHALL be taken from EntityClassLivingSubject
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValuePSN
Fixed ValuePSN
32. LegalAuthenticator.assignedEntity.assignedPerson.determinerCode
Control0..1
BindingThe codes SHALL be taken from EntityDeterminer
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueINSTANCE
Fixed ValueINSTANCE
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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
34. LegalAuthenticator.assignedEntity.assignedPerson.name
Definition

Name of the legal authenticator

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/EN
Must Supporttrue
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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn 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

Control0..1
BindingThe codes SHALL be taken from EntityNameUse
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
37. LegalAuthenticator.assignedEntity.assignedPerson.name.delimiter
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
38. LegalAuthenticator.assignedEntity.assignedPerson.name.family
Definition

HP Family Name/Surname

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
Must Supporttrue
39. LegalAuthenticator.assignedEntity.assignedPerson.name.given
Definition

HP Given Name

Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
Must Supporttrue
40. LegalAuthenticator.assignedEntity.assignedPerson.name.prefix
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
41. LegalAuthenticator.assignedEntity.assignedPerson.name.suffix
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/ENXP
42. LegalAuthenticator.assignedEntity.assignedPerson.name.other
Control0..1
Typestring
XML RepresentationIn 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.

Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/IVL-TS
44. LegalAuthenticator.assignedEntity.assignedPerson.sdtcAsPatientRelationship
Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
XML RepresentationIn 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

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Must Supporttrue