Name Flags Card. Type Description & Constraints Author Author XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, <a href="http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-InfrastructureRoot.html" title="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.">typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) Slices for templateId 1..* II Slice: Unordered, Open by value:root templateId:author 1..1 II @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.4.119 @extension 0..0 time 1..1 TS assignedAuthor C 1..1 AssignedAuthor author-details: Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author. id 1..* II The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant. code 0..1 CE Binding: Healthcare Provider Taxonomy (preferred) Additional Bindings Purpose Documentation Personal And Legal Relationship Role Type Preferred Binding Patient-authored content addr 0..* USRealmAddress Required on at least one instance of this author in the document telecom 0..* TEL Required on at least one instance of this author in the document assignedPerson 0..1 Person assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document name 0..* PN representedOrganization 0..1 Organization assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document id 0..* II name 0..* ON telecom 0..* TEL addr 0..* USRealmAddress Base for all types and resources Documentation for this format
HL7 International - Structured Documents
This template represents the Author Participation (including the author timestamp). CDA R2 requires that Author and Author timestamp be asserted in the document header. From there, authorship propagates to contained sections and contained entries, unless explicitly overridden. The Author Participation template was added to those templates in scope for analysis in R2. Although it is not explicitly stated in all templates the Author Participation template can be used in any template.
Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
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.
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.
Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Identifies the type as an HL7 Registered model
A character string as a unique identifier within the scope of the identifier root.
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
A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
SHALL contain exactly one [1..1] time (CONF:1098-31471).
SHALL contain exactly one [1..1] assignedAuthor (CONF:1098-31472).
Authors require addr, telecom, and either assignedPerson/name or assignedAuthoringDevice/manufacturerModelName. These may be present on this author or on another instance of an Author Participation in the document that has an id that matches the first id of this author.
nullFlavor.exists() or (addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())) or (%resource.descendants().ofType(CDA.AssignedAuthor).where(id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension) and addr.exists() and telecom.exists() and (assignedPerson.name.exists() or assignedAuthoringDevice.manufacturerModelName.exists())))
The first id may be set equal to (a pointer to) an id on a participant elsewhere in the document (header or entries) or a new author participant can be described here. If the id is pointing to a participant already described elsewhere in the document, assignedAuthor/id is sufficient to identify this participant and none of the remaining details of assignedAuthor are required to be set. Application Software must be responsible for resolving the identifier back to its original object and then rendering the information in the correct place in the containing section's narrative text. This id must be a pointer to another author participant.
This assignedAuthor SHALL contain at least one [1..*] id (CONF:1098-31473).
This assignedAuthor SHOULD contain zero or one [0..1] code, which SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:1098-31671).
If the content is patient authored the code **SHOULD** be selected from Personal And Legal Relationship Role Type (2.16.840.1.113883.11.20.12.1) (CONF:1098-32315).
Required on at least one instance of this author in the document
Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
SHALL contain exactly one [1..1] city (CONF:81-7292).
nullFlavor.exists() or item.city.count() = 1
SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291).
nullFlavor.exists() or (item.streetAddressLine.count() >= 1 and item.streetAddressLine.count() <= 4)
nullFlavor.exists() or item.country.exists()
**SHALL NOT** have mixed content except for white space (CONF:81-7296)
If the country is US, the state element is required and SHALL be selected from ValueSet StateValueSet but SHOULD have @nullFlavor if the state is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the state MAY be present but MAY be bound to different vocabularies (CONF:81-10024).
nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.state.exists(nullFlavor.exists() or xmlText.memberOf('http://hl7.org/fhir/us/core/ValueSet/us-core-usps-state'))
If the country is US, the postalCode element is required but SHOULD have @nullFlavor if the postalCode is unknown. If country is not specified, it's assumed to be US. If country is something other than US, the postalCode MAY be present but MAY be bound to different vocabularies (CONF:81-10025).
nullFlavor.exists() or (item.country.exists() and item.country.xmlText != 'US' and item.country.xmlText != 'USA') or item.postalCode.exists(nullFlavor.exists() or xmlText.matches('[0-9]{5}(-[0-9]{4})?'))
SHALL have at most one of each: state, city, postalCode, and country
(item.state.empty() or item.state.count() = 1) and (item.city.empty() or item.city.count() = 1) and (item.postalCode.empty() or item.postalCode.count() = 1) and (item.country.empty() or item.country.count() = 1)
assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
This assignedAuthor MAY contain zero or one [0..1] assignedPerson (CONF:1098-31474).
The assignedPerson, if present, MAY contain zero or more [0..*] name (CONF:1098-31475).
The desc extension allows multimedia depictions of patients, healthcare providers, or other individuals to be included in a CDA document.
Each participant role other than an informant/relatedEntity may have zero or more relationship roles with the patient. Each of these roles can be expressed with an asPatientRelationship element which further describes the type of role using a code element.
assignedPerson/name or representedOrganization/name is required on at least one instance of this author in the document
This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:1098-31476).
The representedOrganization, if present, MAY contain zero or more [0..*] id (CONF:1098-31478).
The representedOrganization, if present, MAY contain zero or more [0..*] name (CONF:1098-31479).
The representedOrganization, if present, MAY contain zero or more [0..*] telecom (CONF:1098-31480).
The representedOrganization, if present, MAY contain zero or more [0..*] addr (CONF:1098-31481).