Consolidated CDA
3.0.0-ballot - ballot
Consolidated CDA
3.0.0-ballot - ballot
This page is part of the CCDA: Consolidated CDA Release (v3.0.0-ballot: CCDA 3.0 Ballot 1) based on FHIR (HL7® FHIR® Standard) v5.0.0. . For a full list of available versions, see the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation | Version: 3.0.0-ballot | |||
| Draft as of 2023-12-21 | Computable Name: ProvenanceAuthorParticipation | |||
| Other Identifiers: id: 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.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Author
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances 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 | (USCDI) Author Time Stamp | ||||||||||
 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. 4515-64: 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). should-code: SHOULD contain 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 | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
 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 | C | 1..* | PN | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given | |||||||||
| item | |||||||||||||
| family | 0..* | ENXP | Family required | ||||||||||
 given | 0..* | ENXP | SHOULD contain given | ||||||||||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | |||||||||||
| representedOrganization | C | 0..1 | Organization | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | example | RoleCode |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() |
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances 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 | (USCDI) Author Time Stamp | ||||||||||
| 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. 4515-64: 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). should-code: SHOULD contain 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 Binding: CDANullFlavor (required) | ||||||||||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | ||||||||||
| @extension | 0..1 | st | |||||||||||
| code | 0..1 | CE | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
| addr | C | 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 | C | 1..* | PN | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given | |||||||||
 item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance | |||||||||
| family | 0..* | ENXP | Family required | ||||||||||
| given | 0..* | ENXP | SHOULD contain given | ||||||||||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | |||||||||||
| representedOrganization | C | 0..1 | Organization | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @nullFlavor | 0..1 | cs | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required) | ||||||||||
| 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) | ||||||||||
| @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) | ||||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.code | example | RoleCode |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | required | CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 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))) | |
| 81-7296 | error | Author.assignedAuthor.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Author.assignedAuthor.addr | 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')) | |
| 81-10025 | error | Author.assignedAuthor.addr | 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})?')) | |
| 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 | |
| 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-city | error | Author.assignedAuthor.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-family | error | Author.assignedAuthor.assignedPerson.name | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-max-ad-parts | error | Author.assignedAuthor.addr | 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) | |
| shall-streetAddressLine | error | Author.assignedAuthor.addr | 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) | |
| should-code | warning | Author.assignedAuthor | SHOULD contain code : code.exists() | |
| should-country | warning | Author.assignedAuthor.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-given | warning | Author.assignedAuthor.assignedPerson.name | SHOULD contain given : item.given.exists() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | Author.assignedAuthor.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() |
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | |||||||||||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | ||||||||||
| 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: ParticipationType (required) Fixed Value: AUT | ||||||||||
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | ||||||||||
| functionCode | 0..1 | CE | |||||||||||
| time | 1..1 | TS | (USCDI) Author Time Stamp | ||||||||||
| 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. 4515-64: 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). should-code: SHOULD contain code | |||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
| addr | C | 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 | ||||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain 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 | |||||||||
 (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 | 0..1 | II | |||||||||||
| @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 | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @nullFlavor | 0..1 | cs | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | CDANullFlavor |
| Author.typeId.nullFlavor | required | CDANullFlavor |
| Author.templateId:provenance-author.nullFlavor | required | CDANullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.assignedAuthor.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.code | example | RoleCode |
| Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.assignedPerson.name.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.name.use | required | CDAEntityNameUse |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 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))) | |
| 81-7296 | error | Author.assignedAuthor.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Author.assignedAuthor.addr | 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')) | |
| 81-10025 | error | Author.assignedAuthor.addr | 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})?')) | |
| 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 | |
| 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-city | error | Author.assignedAuthor.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-family | error | Author.assignedAuthor.assignedPerson.name | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-max-ad-parts | error | Author.assignedAuthor.addr | 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) | |
| shall-streetAddressLine | error | Author.assignedAuthor.addr | 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) | |
| should-code | warning | Author.assignedAuthor | SHOULD contain code : code.exists() | |
| should-country | warning | Author.assignedAuthor.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-given | warning | Author.assignedAuthor.assignedPerson.name | SHOULD contain given : item.given.exists() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | Author.assignedAuthor.addr | SHOULD contain @use : nullFlavor.exists() or use.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:
Differential View
This structure is derived from Author
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances 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 | (USCDI) Author Time Stamp | ||||||||||
| 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. 4515-64: 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). should-code: SHOULD contain 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 | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
| 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 | C | 1..* | PN | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given | |||||||||
| item | |||||||||||||
| family | 0..* | ENXP | Family required | ||||||||||
| given | 0..* | ENXP | SHOULD contain given | ||||||||||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | |||||||||||
| representedOrganization | C | 0..1 | Organization | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.code | example | RoleCode |
| Id | Grade | Path(s) | Details | Requirements |
| 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() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances 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 | (USCDI) Author Time Stamp | ||||||||||
| 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. 4515-64: 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). should-code: SHOULD contain 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 Binding: CDANullFlavor (required) | ||||||||||
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | ||||||||||
| @extension | 0..1 | st | |||||||||||
| code | 0..1 | CE | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
| addr | C | 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 | C | 1..* | PN | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given | |||||||||
| item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance | |||||||||
| family | 0..* | ENXP | Family required | ||||||||||
| given | 0..* | ENXP | SHOULD contain given | ||||||||||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | |||||||||||
| representedOrganization | C | 0..1 | Organization | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @nullFlavor | 0..1 | cs | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required) | ||||||||||
| 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) | ||||||||||
| @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) | ||||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet |
| Author.assignedAuthor.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.code | example | RoleCode |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | required | CDANullFlavor |
| Id | Grade | Path(s) | Details | Requirements |
| 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))) | |
| 81-7296 | error | Author.assignedAuthor.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Author.assignedAuthor.addr | 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')) | |
| 81-10025 | error | Author.assignedAuthor.addr | 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})?')) | |
| 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 | |
| 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-city | error | Author.assignedAuthor.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-family | error | Author.assignedAuthor.assignedPerson.name | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-max-ad-parts | error | Author.assignedAuthor.addr | 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) | |
| shall-streetAddressLine | error | Author.assignedAuthor.addr | 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) | |
| should-code | warning | Author.assignedAuthor | SHOULD contain code : code.exists() | |
| should-country | warning | Author.assignedAuthor.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-given | warning | Author.assignedAuthor.assignedPerson.name | SHOULD contain given : item.given.exists() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | Author.assignedAuthor.addr | SHOULD contain @use : nullFlavor.exists() or use.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Author | 1..1 | Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, typeId, templateId, @typeCode, @contextControlCode, functionCode, time, assignedAuthor Base for all types and resources Instances of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | ||||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | |||||||||||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | ||||||||||
| 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: ParticipationType (required) Fixed Value: AUT | ||||||||||
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | ||||||||||
| functionCode | 0..1 | CE | |||||||||||
| time | 1..1 | TS | (USCDI) Author Time Stamp | ||||||||||
| 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. 4515-64: 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). should-code: SHOULD contain code | |||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | 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: v3 Code System RoleCode (example): See additional bindings
| ||||||||||
| addr | C | 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 | ||||||||||
| @nullFlavor | 0..1 | cs | Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain 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 | |||||||||
| (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 | 0..1 | II | |||||||||||
| @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 | (USCDI) Author Organization - 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). provenance-org-details: If the author is not a clinician, set nullFlavor='NA'. Otherwise, the taxId, npi, and name are required. should-telecom: SHOULD contain telecom | |||||||||
| @nullFlavor | 0..1 | cs | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: CDANullFlavor (required) | ||||||||||
| realmCode | 0..* | CS | |||||||||||
| typeId | 0..1 | II | |||||||||||
| @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 | |||||||||||
| Documentation for this format | |||||||||||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | CDANullFlavor |
| Author.typeId.nullFlavor | required | CDANullFlavor |
| Author.templateId:provenance-author.nullFlavor | required | CDANullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.assignedAuthor.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.code | example | RoleCode |
| Author.assignedAuthor.assignedPerson.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.assignedPerson.name.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.name.use | required | CDAEntityNameUse |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.assignedPerson.sdtcAsPatientRelationship.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.typeId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.id:taxId.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.id:npi.nullFlavor | required | CDANullFlavor |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | example | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 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))) | |
| 81-7296 | error | Author.assignedAuthor.addr | **SHALL NOT** have mixed content except for white space (CONF:81-7296) : item.xmlText.empty() | |
| 81-10024 | error | Author.assignedAuthor.addr | 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')) | |
| 81-10025 | error | Author.assignedAuthor.addr | 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})?')) | |
| 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 | |
| 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-city | error | Author.assignedAuthor.addr | SHALL contain exactly one [1..1] city (CONF:81-7292). : nullFlavor.exists() or item.city.count() = 1 | |
| shall-family | error | Author.assignedAuthor.assignedPerson.name | SHALL contain exactly one [1..1] family (CONF:81-7159). : nullFlavor.exists() or item.family.count() = 1 | |
| shall-max-ad-parts | error | Author.assignedAuthor.addr | 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) | |
| shall-streetAddressLine | error | Author.assignedAuthor.addr | 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) | |
| should-code | warning | Author.assignedAuthor | SHOULD contain code : code.exists() | |
| should-country | warning | Author.assignedAuthor.addr | SHOULD contain country : nullFlavor.exists() or item.country.exists() | |
| should-given | warning | Author.assignedAuthor.assignedPerson.name | SHOULD contain given : item.given.exists() | |
| should-telecom | warning | Author.assignedAuthor.representedOrganization | SHOULD contain telecom : telecom.exists() | |
| should-use | warning | Author.assignedAuthor.addr | SHOULD contain @use : nullFlavor.exists() or use.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:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#3.0.0-ballot based on FHIR 5.0.0. Generated 2023-12-21
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change