Generated Narrative: StructureDefinition ProvenanceAuthorParticipation Name Flags Card. Type Description & Constraints Author Author XML Namespace: urn:hl7-org:v3 Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) #xD; Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension #xD; templateId:provenance-author 1..1 II #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6 #xD; @extension 1..1 st Required Pattern: 2019-10-01 #xD; time 1..1 TS 헨?헦?헖?헗?헜?: Author Time Stamp #xD; assignedAuthor <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( author-details, 4515-64, should-code )">C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code #xD; Slices for id 1..* II Slice: Unordered, Open by value:root #xD; id:npi 1..1 II #xD; @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6 #xD; @extension 0..1 st #xD; code 0..1 CE 헨?헦?헖?헗?헜?: Author Role - When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient. Binding: CDARoleCode (example): See additional bindings Additional Bindings Purpose Documentation Healthcare Provider Taxonomy Preferred Providers Personal And Legal Relationship Role Type Preferred Non-clinicians #xD; addr 0..* USRealmAddress Required on at least one instance of this author in the document #xD; telecom 0..* TEL Required on at least one instance of this author in the document #xD; assignedPerson 0..1 Person 헨?헦?헖?헗?헜?: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document #xD; name <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( shall-family, should-given )">C 1..* PN Constraints: shall-family, should-given #xD; item #xD; family 0..* ENXP Family required #xD; given 0..* ENXP SHOULD contain given #xD; assignedAuthoringDevice 0..1 AuthoringDevice #xD; representedOrganization <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R5/conformance-rules.html#constraints" title="This element has or is affected by constraints ( provenance-org-details )">C 0..1 Organization 헨?헦?헖?헗?헜?: Author Organization Constraints: provenance-org-details #xD; @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician #xD; Slices for id 0..* II Slice: Unordered, Open by value:root #xD; id:taxId 0..1 II #xD; @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2 #xD; @extension 0..1 st #xD; id:npi 0..1 II #xD; @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK #xD; @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6 #xD; @extension 0..1 st #xD; name 0..1 ON #xD; telecom 0..* TEL #xD; Documentation for this format
HL7 International - Structured Documents
This template represents the key information to record Provenance in an Author Participation. This Participation is appropriate at any place CDA allows an author. For example, at the CDA Header, CDA Section, CDA Entry, or within a CDA entry (e.g. Organizer and contained Observation(s)). This template is consistent with the C-CDA Author Participation, however, it doesnt use a formal conforms to relationship. All constraints for conformance are defined in this template which specializes the Author Participation (2.16.840.1.113883.10.20.22.4.119). This template is used to identify primary authorship for an entry. An entry may have many authors, but recipients need a single authoritative point of contact for resolving issues. This is typically the last provider to make substantive changes to the entry If two providers are simultaneously involved in that activity, the implementer must choose one, ideally in a repeatable way. The `assignedAuthor/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. Note: The Provenance template title includes a version 2 to support moving from the 'Basic Provenance' guide to the this Companion Guide, so the templateId has not changed.
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.
An II instance must have either a root or an nullFlavor.
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:4515-32983).
SHALL contain exactly one [1..1] assignedAuthor (CONF:4515-32975).
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())))
If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (CONF:4515-64).
representedOrganization.exists() or (%resource.descendants().ofType(CDA.Author).where(templateId.exists($this.root = '2.16.840.1.113883.10.20.22.5.6' and $this.extension = '2019-10-01') and assignedAuthor.representedOrganization.exists() and assignedAuthor.id.exists($this.root = %context.id.first().root and $this.extension ~ %context.id.first().extension)))
This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that. it This assignedAuthor SHALL contain at least one [1..*] id (CONF:4515-2).
This assignedAuthor SHALL contain exactly one [1..1] id (CONF:4515-20) such that it
If NPI is unknown, set @nullFlavor to UNK
SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-22).
SHOULD contain zero or one [0..1] @extension (CONF:4515-23).
𝗨𝗦𝗖𝗗𝗜: Author Role - When the author is a person who is not acting in the role of a clinician, this code encodes the personal or legal relationship between author and the patient.
This assignedAuthor SHOULD contain zero or one [0..1] code (CONF:4515-32979).
If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56).
If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57).
Required on at least one instance of this author in the document
𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
The assignedPerson, if present, SHALL contain at least one [1..*] name (CONF:4515-32977).
SHALL contain exactly one [1..1] family (CONF:81-7159).
nullFlavor.exists() or item.family.count() = 1
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
A series of items that constitute the name.
Can only have only one of the possible item elements in each choice
(delimiter | family | given | prefix | suffix | xmlText).count() = 1
Such names SHALL contain exactly one [1..1] family (CONF:4515-17).
Such names SHOULD contain zero or more [0..*] given (CONF:4515-18).
This element is represented in XML as textual content. The actual name "xmlText" will not appear in a CDA instance.
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.
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.
This assignedAuthor MAY contain zero or one [0..1] assignedAuthoringDevice (CONF:4515-32).
If the assignedAuthor/id is not referencing a Provenance Author described elsewhere in the document with a representedOrganization populated, this assignedAuthor SHALL contain exactly one [1..1] representedOrganization (See - CONF:4440-64). This assignedAuthor MAY contain zero or one [0..1] representedOrganization (CONF:4515-32978).
If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required.
A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
The representedOrganization, if present, MAY contain zero or one [0..1] @nullFlavor (CONF:4515-35).
The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it. The representedOrganization, if present, SHALL contain at least one [1..*] id (CONF:4515-32981).
The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-24) such that it
If Tax ID Number is unknown, set @nullFlavor to UNK
SHOULD contain zero or one [0..1] @extension (CONF:4515-32982).
The representedOrganization, if present, SHALL contain exactly one [1..1] id (CONF:4515-28) such that it
SHALL contain exactly one [1..1] @root="2.16.840.1.113883.4.6" National Provider Identifier (CONF:4515-30).
SHOULD contain zero or one [0..1] @extension (CONF:4515-31).
The representedOrganization, if present, SHALL contain exactly one [1..1] name (CONF:4515-11).
The representedOrganization, if present, SHOULD contain zero or more [0..*] telecom (CONF:4515-12).