Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication
2.1 - CI Build
Consolidated CDA Release 2.1 StructureDefinition Publication, published by Health Level Seven. This is not an authorized publication; it is the continuous build for version 2.1). This version is based on the current content of https://github.com/HL7/CDA-ccda-2.1-sd/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation | Version: 2.1 | |||
| Draft as of 2023-09-29 | 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 CDAR2.Author
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
  Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
   templateId:templateId1 | 1..1 | II | templateId | |
  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 | ||
 assignedAuthor | 1..1 | AssignedAuthor | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| extension | 0..1 | st | ||
| code | C | 0..1 | CE | 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| assignedPerson | 0..1 | Person | ||
| name | 1..* | PN | ||
| family | 1..1 | ENXP | ||
 given | 0..* | ENXP | ||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| nullFlavor | 0..1 | cs | ||
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
 id:id1 | 1..1 | II | id | |
 nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.2 | |
| extension | 0..1 | st | ||
| id:id2 | 1..1 | II | id | |
| nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| extension | 0..1 | st | ||
| name | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
 @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 | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| code | C | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| assignedPerson | 0..1 | Person | ||
| name | 1..* | PN | ||
| family | 1..1 | ENXP | ||
| given | 0..* | ENXP | ||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
| id:id1 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.2 | |
| @extension | 0..1 | st | ||
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| name | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.assignedAuthor.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.code | extensible | RoleCode |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.id:id1.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.id:id2.nullFlavor | required | Fixed Value: UNK |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationType (required) Fixed Value: AUT | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
| functionCode | 0..1 | CE | ||
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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 | C | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | 1..* | PN | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @use | 0..1 | cs | Binding: EntityNameUse (required) | |
| delimiter | 0..* | ENXP | ||
| family | 1..1 | ENXP | ||
| given | 0..* | ENXP | ||
| prefix | 0..* | ENXP | ||
| suffix | 0..* | ENXP | ||
| other | 0..1 | st | ||
| validTime | 0..1 | IVL_TS | ||
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
| id:id1 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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 | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
| asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | NullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.templateId:templateId1.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.code | extensible | RoleCode |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.assignedPerson.name.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.assignedPerson.name.use | required | EntityNameUse |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.id:id1.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Author
Summary
Mandatory: 6 elements (7 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
Differential View
This structure is derived from CDAR2.Author
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| 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 | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| extension | 0..1 | st | ||
| code | C | 0..1 | CE | 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| assignedPerson | 0..1 | Person | ||
| name | 1..* | PN | ||
| family | 1..1 | ENXP | ||
| given | 0..* | ENXP | ||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| nullFlavor | 0..1 | cs | ||
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
| id:id1 | 1..1 | II | id | |
| nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.2 | |
| extension | 0..1 | st | ||
| id:id2 | 1..1 | II | id | |
| nullFlavor | 0..1 | cs | Fixed Value: UNK | |
| root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| extension | 0..1 | st | ||
| name | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| Documentation for this format | ||||
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @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 | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| code | C | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| assignedPerson | 0..1 | Person | ||
| name | 1..* | PN | ||
| family | 1..1 | ENXP | ||
| given | 0..* | ENXP | ||
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
| id:id1 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.2 | |
| @extension | 0..1 | st | ||
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @root | 1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.4.6 | |
| @extension | 0..1 | st | ||
| name | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.assignedAuthor.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.code | extensible | RoleCode |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.id:id1.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.id:id2.nullFlavor | required | Fixed Value: UNK |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Author | 1..1 | CDAR2.Author | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, @typeCode, @contextControlCode, realmCode, typeId, templateId, functionCode, time, assignedAuthor Base for all types and resources | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @typeCode | 0..1 | cs | Binding: ParticipationType (required) Fixed Value: AUT | |
| @contextControlCode | 0..1 | cs | Binding: ContextControl (required) Fixed Value: OP | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |
| templateId:templateId1 | 1..1 | II | templateId | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (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 | |
| functionCode | 0..1 | CE | ||
| time | 1..1 | TS | ||
| assignedAuthor | 1..1 | AssignedAuthor | ||
| @classCode | 0..1 | cs | Binding: RoleClassAssignedEntity (required) Fixed Value: ASSIGNED | |
| templateId | 0..* | II | ||
| Slices for id | C | 1..* | II | Slice: Unordered, Open by value:root 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). |
| id:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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 | C | 0..1 | CE | Binding: v3 Code System RoleCode (extensible) 4515-56: If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). 4515-57: If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). |
| addr | 0..* | AD | ||
| telecom | 0..* | TEL | ||
| assignedPerson | 0..1 | Person | ||
| @classCode | 0..1 | cs | Binding: EntityClassLivingSubject (required) Fixed Value: PSN | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| templateId | 0..* | II | ||
| name | 1..* | PN | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @use | 0..1 | cs | Binding: EntityNameUse (required) | |
| delimiter | 0..* | ENXP | ||
| family | 1..1 | ENXP | ||
| given | 0..* | ENXP | ||
| prefix | 0..* | ENXP | ||
| suffix | 0..* | ENXP | ||
| other | 0..1 | st | ||
| validTime | 0..1 | IVL_TS | ||
| sdtcAsPatientRelationship | 0..* | CE | XML Namespace: urn:hl7-org:sdtc XML: asPatientRelationship (urn:hl7-org:sdtc) | |
| assignedAuthoringDevice | 0..1 | AuthoringDevice | ||
| representedOrganization | 0..1 | Organization | ||
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) | |
| @classCode | 0..1 | cs | Binding: EntityClassOrganization (required) Fixed Value: ORG | |
| @determinerCode | 0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |
| realmCode | 0..* | CS | ||
| typeId | 0..1 | II | ||
| templateId | 0..* | II | ||
| Slices for id | 2..* | II | Slice: Unordered, Open by value:root | |
| id:id1 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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:id2 | 1..1 | II | id | |
| @nullFlavor | 0..1 | cs | Binding: NullFlavor (required) Fixed Value: UNK | |
| @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 | 1..1 | ON | ||
| telecom | 0..* | TEL | ||
| addr | 0..* | AD | ||
| standardIndustryClassCode | 0..1 | CE | Binding: OrganizationIndustryClassNAICS (extensible) | |
| asOrganizationPartOf | 0..1 | OrganizationPartOf | ||
| Documentation for this format | ||||
| Path | Conformance | ValueSet / Code |
| Author.nullFlavor | required | NullFlavor |
| Author.typeCode | required | Fixed Value: AUT |
| Author.contextControlCode | required | Fixed Value: OP |
| Author.templateId:templateId1.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.classCode | required | Fixed Value: ASSIGNED |
| Author.assignedAuthor.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.code | extensible | RoleCode |
| Author.assignedAuthor.assignedPerson.classCode | required | Fixed Value: PSN |
| Author.assignedAuthor.assignedPerson.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.assignedPerson.name.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.assignedPerson.name.use | required | EntityNameUse |
| Author.assignedAuthor.representedOrganization.nullFlavor | required | NullFlavor |
| Author.assignedAuthor.representedOrganization.classCode | required | Fixed Value: ORG |
| Author.assignedAuthor.representedOrganization.determinerCode | required | Fixed Value: INSTANCE |
| Author.assignedAuthor.representedOrganization.id:id1.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.id:id2.nullFlavor | required | Fixed Value: UNK |
| Author.assignedAuthor.representedOrganization.standardIndustryClassCode | extensible | OrganizationIndustryClassNAICS |
| Id | Grade | Path(s) | Details | Requirements |
| 4515-56 | warning | Author.assignedAuthor.code | If the content is provider authored, the code SHOULD be selected from ValueSet Healthcare Provider Taxonomy urn:oid:2.16.840.1.114222.4.11.1066 DYNAMIC (CONF:4515-56). : | |
| 4515-57 | warning | Author.assignedAuthor.code | If the author is a person who is not acting in the role of a clinician, the code SHOULD be selected from ValueSet Personal And Legal Relationship Role Type urn:oid:2.16.840.1.113883.11.20.12.1 DYNAMIC (CONF:4515-57). : | |
| 4515-64 | error | Author.assignedAuthor.id | 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). : | |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
This structure is derived from CDAR2.Author
Summary
Mandatory: 6 elements (7 nested mandatory elements)
Fixed Value: 3 elements
Slices
This structure defines the following Slices:
IG © 2019+ Health Level Seven. Package hl7.cda.us.ccda#2.1 based on FHIR 5.0.0. Generated 2023-09-29
Links: Table of Contents |
QA Report
| Version History 
|
|
Propose a change