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

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
Control1..*1
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Author.typeCode
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Author.contextControlCode
XML RepresentationIn the XML format, this property is represented as an attribute.
4. Author.functionCode
Must Supporttrue
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 Supporttrue
6. Author.assignedAuthor
Must Supporttrue
7. Author.assignedAuthor.determinerCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueINSTANCE
8. Author.assignedAuthor.name
Definition

Name of the person (e.g. the Healthcare Professional.html)  authoring this document

Control1..*
Must Supporttrue
9. Author.assignedAuthor.name.family
Control1..*
Must Supporttrue
10. Author.assignedAuthor.name.given
Control1..*
Must Supporttrue
11. Author.assignedAuthor.classCode
Control0..1
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValuePSN
12. Author.assignedAuthor.id
Definition

Author Identifier(s.html)

Control1..*
Must Supporttrue
13. Author.assignedAuthor.id.nullFlavor
Control0..1
Typecode
XML RepresentationIn 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.

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
15. Author.assignedAuthor.addr
Control1..*
Must Supporttrue
16. Author.assignedAuthor.telecom
Control1..*
Must Supporttrue
17. Author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
18. Author.assignedAuthor.telecom.use
Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse TelecommunicationAddressUs
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Author.assignedAuthor.representedOrganization
Control0..1
Must Supporttrue

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.

Control10..*
Must Supporttrue
XML RepresentationIn the XML format, this property has the namespace urn:hl7-org:v3.
2. Author.typeCode
Control0..1
BindingThe codes SHALL be taken from ParticipationType
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Fixed ValueAUT
3. Author.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
4. Author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
5. Author.time
Definition

The author/time element represents the start time of the author’s participation in the creation of the clinical document. 

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
6. Author.assignedAuthor
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor
Must Supporttrue
7. Author.assignedAuthor.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValuePSN
8. Author.assignedAuthor.id
Definition

Author Identifier(s.html)

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

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

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
11. Author.assignedAuthor.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
12. Author.assignedAuthor.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
13. Author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn 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.

Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse TelecommunicationAddressUs
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
15. Author.assignedAuthor.representedOrganization
Control0..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. Author
Definition

Base definition for all types defined in FHIR type system.

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

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

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

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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
8. Author.functionCode
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/CE
Must Supporttrue
9. Author.time
Definition

The author/time element represents the start time of the author’s participation in the creation of the clinical document. 

Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/TS
Must Supporttrue
10. Author.assignedAuthor
Control1..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AssignedAuthor
Must Supporttrue
11. Author.assignedAuthor.classCode
Control0..1
BindingThe codes SHALL be taken from RoleClassAssignedEntity
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
Default ValueASSIGNED
Fixed ValuePSN
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

Control0..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/II
13. Author.assignedAuthor.id
Definition

Author Identifier(s.html)

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

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

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

Control0..1
Typeboolean
XML RepresentationIn 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.

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

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Author.assignedAuthor.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.
20. Author.assignedAuthor.code
Definition

A code, which identifies the profession/competence/specialty of the author when it is a person.

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
21. Author.assignedAuthor.addr
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/AD
Must Supporttrue
22. Author.assignedAuthor.telecom
Control1..*
Typehttp://hl7.org/fhir/cda/StructureDefinition/TEL
Must Supporttrue
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.

Control0..1
BindingThe codes SHALL be taken from NullFlavor
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
24. Author.assignedAuthor.telecom.value
Control0..1
Typeuri
XML RepresentationIn 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.

Control0..*
TypeChoice 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 Typehttp://hl7.org/fhir/cda/StructureDefinition/SXPR-TS
XML RepresentationThe 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.

Control0..1
BindingThe codes SHALL be taken from TelecommunicationAddressUse TelecommunicationAddressUs
Typecode
XML RepresentationIn the XML format, this property is represented as an attribute.
27. Author.assignedAuthor.assignedPerson
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Person
28. Author.assignedAuthor.assignedAuthoringDevice
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/AuthoringDevice
29. Author.assignedAuthor.representedOrganization
Control0..1
Typehttp://hl7.org/fhir/cda/StructureDefinition/Organization
Must Supporttrue