Consolidated CDA (C-CDA)
4.0.0 - STU4 United States of America flag

Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions

Logical Model: Provenance - Author Participation

Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation Version: 4.0.0
Draft as of 2025-10-02 Computable Name: ProvenanceAuthorParticipation
Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.5.6:2019-10-01

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.

Usages:

You can also check for usages in the FHIR IG Statistics

Changes since version 3.0.0:

  • New Content

    • Formal Views of Template Content

    Description of Template, Differentials, Snapshots and how the different presentations work.

    This structure is derived from Author

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author Author XML Namespace: urn:hl7-org:v3
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:provenance-author 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... item
    ....... family 0..* ENXP Family required
    ....... given 0..* ENXP SHOULD contain given
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author 1..1 Author XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:provenance-author 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: AUT
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 0..1 CE
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @classCode 0..1 cs Binding: RoleClassAssignedEntity (required)
    Fixed Value: ASSIGNED
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
    Fixed Value: PSN
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @use 0..* cs Binding: CDAEntityNameUse (required)
    ...... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    ....... (Choice of one) 1..1
    ........ delimiter 0..* ENXP
    ........ family 0..* ENXP Family required
    ........ given 0..* ENXP SHOULD contain given
    ........ prefix 0..* ENXP
    ........ suffix 0..* ENXP
    ........ xmlText 0..1 st Allows for mixed text content
    ...... validTime 0..1 IVL_TS
    ..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
    XML: desc (urn:hl7-org:sdtc)
    ..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
    XML: asPatientRelationship (urn:hl7-org:sdtc)
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Fixed Value: PRS
    ...... @determinerCode 0..1 cs Fixed Value: INSTANCE
    ...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
    XML Namespace: urn:hl7-org:sdtc
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
    Fixed Value: ORG
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL
    ..... addr 0..* AD
    ..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
    ..... asOrganizationPartOf 0..1 OrganizationPartOf

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Author.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.templateId:provenance-author.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​classCode Base required RoleClassAssignedEntity 📦3.0.0 THO v6.5
    Author.assignedAuthor.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.classCode Base required EntityClassLivingSubject 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.name.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.name.​use Base required CDAEntityNameUse 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​classCode Base required EntityClassOrganization 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​id:taxId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​standardIndustryClassCode Base example OrganizationIndustryClassNAICS 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    EN-1 error Author.assignedAuthor.assignedPerson.name.item Can only have only one of the possible item elements in each choice (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    II-1 error Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author 1..1 Author XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:provenance-author 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: AUT
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 0..1 CE
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @classCode 0..1 cs Binding: RoleClassAssignedEntity (required)
    Fixed Value: ASSIGNED
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
    Fixed Value: PSN
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @use 0..* cs Binding: CDAEntityNameUse (required)
    ...... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    ....... (Choice of one) 1..1
    ........ delimiter 0..* ENXP
    ........ family 0..* ENXP Family required
    ........ given 0..* ENXP SHOULD contain given
    ........ prefix 0..* ENXP
    ........ suffix 0..* ENXP
    ........ xmlText 0..1 st Allows for mixed text content
    ...... validTime 0..1 IVL_TS
    ..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
    XML: desc (urn:hl7-org:sdtc)
    ..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
    XML: asPatientRelationship (urn:hl7-org:sdtc)
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Fixed Value: PRS
    ...... @determinerCode 0..1 cs Fixed Value: INSTANCE
    ...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
    XML Namespace: urn:hl7-org:sdtc
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
    Fixed Value: ORG
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL
    ..... addr 0..* AD
    ..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
    ..... asOrganizationPartOf 0..1 OrganizationPartOf

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Author.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.templateId:provenance-author.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​classCode Base required RoleClassAssignedEntity 📦3.0.0 THO v6.5
    Author.assignedAuthor.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.classCode Base required EntityClassLivingSubject 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.name.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.name.​use Base required CDAEntityNameUse 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​classCode Base required EntityClassOrganization 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​id:taxId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​standardIndustryClassCode Base example OrganizationIndustryClassNAICS 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    EN-1 error Author.assignedAuthor.assignedPerson.name.item Can only have only one of the possible item elements in each choice (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    II-1 error Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()

    This structure is derived from Author

    Summary

    Mandatory: 6 elements(3 nested mandatory elements)

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Author.templateId
    • The element 1 is sliced based on the value of Author.assignedAuthor.id
    • The element 1 is sliced based on the value of Author.assignedAuthor.representedOrganization.id

    Differential View

    This structure is derived from Author

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author Author XML Namespace: urn:hl7-org:v3
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... Slices for templateId 1..* II Slice: Unordered, Open by value:root, value:extension
    .... templateId:provenance-author 1..1 II
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... item
    ....... family 0..* ENXP Family required
    ....... given 0..* ENXP SHOULD contain given
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL

    doco Documentation for this format

    Terminology Bindings (Differential)

    Path Status Usage ValueSet Version Source
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()

    Key Elements View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author 1..1 Author XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:provenance-author 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: AUT
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 0..1 CE
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @classCode 0..1 cs Binding: RoleClassAssignedEntity (required)
    Fixed Value: ASSIGNED
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
    Fixed Value: PSN
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @use 0..* cs Binding: CDAEntityNameUse (required)
    ...... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    ....... (Choice of one) 1..1
    ........ delimiter 0..* ENXP
    ........ family 0..* ENXP Family required
    ........ given 0..* ENXP SHOULD contain given
    ........ prefix 0..* ENXP
    ........ suffix 0..* ENXP
    ........ xmlText 0..1 st Allows for mixed text content
    ...... validTime 0..1 IVL_TS
    ..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
    XML: desc (urn:hl7-org:sdtc)
    ..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
    XML: asPatientRelationship (urn:hl7-org:sdtc)
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Fixed Value: PRS
    ...... @determinerCode 0..1 cs Fixed Value: INSTANCE
    ...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
    XML Namespace: urn:hl7-org:sdtc
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
    Fixed Value: ORG
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL
    ..... addr 0..* AD
    ..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
    ..... asOrganizationPartOf 0..1 OrganizationPartOf

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Author.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.templateId:provenance-author.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​classCode Base required RoleClassAssignedEntity 📦3.0.0 THO v6.5
    Author.assignedAuthor.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.classCode Base required EntityClassLivingSubject 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.name.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.name.​use Base required CDAEntityNameUse 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​classCode Base required EntityClassOrganization 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​id:taxId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​standardIndustryClassCode Base example OrganizationIndustryClassNAICS 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    EN-1 error Author.assignedAuthor.assignedPerson.name.item Can only have only one of the possible item elements in each choice (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    II-1 error Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Author 1..1 Author XML Namespace: urn:hl7-org:v3
    Base for all types and resources
    Instance of this type are validated by templateId
    Logical Container: ClinicalDocument (CDA Class)
    ... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ... realmCode 0..* CS
    ... typeId C 0..1 II Constraints: II-1
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... @assigningAuthorityName 0..1 st
    .... @displayable 0..1 bl
    .... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    .... @extension 1..1 st
    .... templateId:provenance-author 1..1 II
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.6
    ..... @extension 1..1 st Required Pattern: 2019-10-01
    ... @typeCode 0..1 cs Binding: CDAParticipationType (required)
    Fixed Value: AUT
    ... @contextControlCode 0..1 cs Binding: CDAContextControl (required)
    Fixed Value: OP
    ... functionCode 0..1 CE
    ... time 1..1 TS 𝗨𝗦𝗖𝗗𝗜: Author Time Stamp
    ... assignedAuthor C 1..1 AssignedAuthor Constraints: author-details, 4515-64, should-code
    .... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    .... realmCode 0..* CS
    .... typeId C 0..1 II Constraints: II-1
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... @assigningAuthorityName 0..1 st
    ..... @displayable 0..1 bl
    ..... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ..... @extension 1..1 st
    .... templateId 0..* II
    .... @classCode 0..1 cs Binding: RoleClassAssignedEntity (required)
    Fixed Value: ASSIGNED
    .... Slices for id 1..* II Slice: Unordered, Open by value:root
    ..... id:npi 1..1 II
    ...... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ...... @extension 0..1 st
    .... sdtcIdentifiedBy 0..* IdentifiedBy XML Namespace: urn:hl7-org:sdtc
    XML: identifiedBy (urn:hl7-org:sdtc)
    .... 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 BindingsPurposeDocumentation
    Healthcare Provider Taxonomy . Preferred
    Providers
    Personal And Legal Relationship Role Type . Preferred
    Non-clinicians
    .... 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 𝗨𝗦𝗖𝗗𝗜: Author - assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document
    ..... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassLivingSubject (required)
    Fixed Value: PSN
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... name C 1..* PN Constraints: shall-family, should-given
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @use 0..* cs Binding: CDAEntityNameUse (required)
    ...... item C 1..* Base Choice Group: This is a repeating choice group that does not appear directly in the instance
    Constraints: EN-1
    ....... (Choice of one) 1..1
    ........ delimiter 0..* ENXP
    ........ family 0..* ENXP Family required
    ........ given 0..* ENXP SHOULD contain given
    ........ prefix 0..* ENXP
    ........ suffix 0..* ENXP
    ........ xmlText 0..1 st Allows for mixed text content
    ...... validTime 0..1 IVL_TS
    ..... sdtcDesc 0..1 ED XML Namespace: urn:hl7-org:sdtc
    XML: desc (urn:hl7-org:sdtc)
    ..... sdtcAsPatientRelationship 0..* InfrastructureRoot XML Namespace: urn:hl7-org:sdtc
    XML: asPatientRelationship (urn:hl7-org:sdtc)
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... realmCode 0..* CS
    ...... typeId C 0..1 II Constraints: II-1
    ....... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ....... @extension 1..1 st
    ...... templateId 0..* II
    ...... @classCode 1..1 cs Fixed Value: PRS
    ...... @determinerCode 0..1 cs Fixed Value: INSTANCE
    ...... code 1..1 CE XML Namespace: urn:hl7-org:sdtc
    XML Namespace: urn:hl7-org:sdtc
    .... assignedAuthoringDevice 0..1 AuthoringDevice
    .... representedOrganization C 0..1 Organization 𝗨𝗦𝗖𝗗𝗜: Author Organization
    Constraints: provenance-org-details
    ..... @nullFlavor 0..1 cs A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician
    Binding: CDANullFlavor (required)
    ..... realmCode 0..* CS
    ..... typeId C 0..1 II Constraints: II-1
    ...... @nullFlavor 0..1 cs Binding: CDANullFlavor (required)
    ...... @assigningAuthorityName 0..1 st
    ...... @displayable 0..1 bl
    ...... @root 1..1 oid, uuid, ruid Fixed Value: 2.16.840.1.113883.1.3
    ...... @extension 1..1 st
    ..... templateId 0..* II
    ..... @classCode 0..1 cs Binding: EntityClassOrganization (required)
    Fixed Value: ORG
    ..... @determinerCode 0..1 cs Binding: EntityDeterminer (required)
    Fixed Value: INSTANCE
    ..... Slices for id 0..* II Slice: Unordered, Open by value:root
    ...... id:taxId 0..1 II
    ....... @nullFlavor 0..1 cs If Tax ID Number is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.2
    ....... @extension 0..1 st
    ...... id:npi 0..1 II
    ....... @nullFlavor 0..1 cs If NPI is unknown, set @nullFlavor to UNK
    Binding: CDANullFlavor (required)
    ....... @assigningAuthorityName 0..1 st
    ....... @displayable 0..1 bl
    ....... @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.6
    ....... @extension 0..1 st
    ..... name 0..1 ON
    ..... telecom 0..* TEL
    ..... addr 0..* AD
    ..... standardIndustryClassCode 0..1 CE Binding: OrganizationIndustryClassNAICS (example)
    ..... asOrganizationPartOf 0..1 OrganizationPartOf

    doco Documentation for this format

    Terminology Bindings

    Path Status Usage ValueSet Version Source
    Author.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.templateId:provenance-author.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.typeCode Base required CDAParticipationType 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.contextControlCode Base required CDAContextControl 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​classCode Base required RoleClassAssignedEntity 📦3.0.0 THO v6.5
    Author.assignedAuthor.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​code Base example CDARoleCode 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.typeId.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.classCode Base required EntityClassLivingSubject 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​assignedPerson.name.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.name.​use Base required CDAEntityNameUse 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​assignedPerson.sdtcAsPatientRelationship.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​typeId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​classCode Base required EntityClassOrganization 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​determinerCode Base required EntityDeterminer 📦3.0.0 THO v6.5
    Author.assignedAuthor.​representedOrganization.​id:taxId.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​id:npi.nullFlavor Base required CDANullFlavor 📦2.0.1-sd Clinical Document Architecture v2.0
    Author.assignedAuthor.​representedOrganization.​standardIndustryClassCode Base example OrganizationIndustryClassNAICS 📦3.0.0 THO v6.5

    Constraints

    Id Grade Path(s) Description Expression
    4515-64 error Author.assignedAuthor 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)))
    EN-1 error Author.assignedAuthor.assignedPerson.name.item Can only have only one of the possible item elements in each choice (delimiter | family | given | prefix | suffix | xmlText).count() = 1
    II-1 error Author.typeId, Author.assignedAuthor.typeId, Author.assignedAuthor.assignedPerson.typeId, Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId, Author.assignedAuthor.representedOrganization.typeId An II instance must have either a root or an nullFlavor. root.exists() or nullFlavor.exists()
    author-details error Author.assignedAuthor 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())))
    provenance-org-details error Author.assignedAuthor.representedOrganization If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. nullFlavor = 'NA' or (id.where(root='2.16.840.1.113883.4.2').exists() and id.where(root='2.16.840.1.113883.4.6').exists() and name.exists())
    shall-family error Author.assignedAuthor.assignedPerson.name SHALL contain exactly one [1..1] family (CONF:81-7159). nullFlavor.exists() or item.family.count() = 1
    should-code warning Author.assignedAuthor SHOULD contain code code.exists()
    should-given warning Author.assignedAuthor.assignedPerson.name SHOULD contain given item.given.exists()

    This structure is derived from Author

    Summary

    Mandatory: 6 elements(3 nested mandatory elements)

    Structures

    This structure refers to these other structures:

    Slices

    This structure defines the following Slices:

    • The element 2 is sliced based on the values of Author.templateId
    • The element 1 is sliced based on the value of Author.assignedAuthor.id
    • The element 1 is sliced based on the value of Author.assignedAuthor.representedOrganization.id

     

    Other representations of profile: CSV, Excel