Left: | Provenance - Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation) |
Right: | Provenance - Author Participation (http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation) |
Error | StructureDefinition.version | Values for version differ: '3.0.0' vs '4.0.0' |
Information | StructureDefinition.date | Values for date differ: '2024-05-18T00:16:25-05:00' vs '2024-10-19T22:19:38+00:00' |
Name | Value | Comments | |
---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/cda/stds/core/StructureDefinition/Author | ||
copyright | |||
date | 2024-05-18T00:16:25-05:00 | 2024-10-19T22:19:38+00:00 |
|
description | 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. | ||
experimental | |||
fhirVersion | 5.0.0 | ||
jurisdiction | |||
jurisdiction[0] | urn:iso:std:iso:3166#US | ||
kind | logical | ||
name | ProvenanceAuthorParticipation | ||
publisher | Health Level Seven | ||
purpose | |||
status | draft | ||
title | Provenance - Author Participation | ||
type | http://hl7.org/cda/stds/core/StructureDefinition/Author | ||
url | http://hl7.org/cda/us/ccda/StructureDefinition/ProvenanceAuthorParticipation | ||
version | 3.0.0 | 4.0.0 |
|
Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Author | 1..1 | Author | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | 1..1 | Author | Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) | |||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
realmCode | 0..* | CS | 0..* | CS | |||||||||||||||||||||||
typeId | 0..1 | II | 0..1 | II | |||||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||||||||||||||||||||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||||||||||||||||||||
Slices for templateId | 1..* | II | Slice: Unordered, Open by value:root, value:extension | 1..* | II | Slice: Unordered, Open by value:root, value:extension | |||||||||||||||||||||
typeCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: AUT | 0..1 | ?? | Binding: ?? (required) Fixed Value: AUT | |||||||||||||||||||||
contextControlCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: OP | 0..1 | ?? | Binding: ?? (required) Fixed Value: OP | |||||||||||||||||||||
functionCode | 0..1 | CE | 0..1 | CE | |||||||||||||||||||||||
time | 1..1 | TS | (USCDI) Author Time Stamp | 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 | 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 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
realmCode | 0..* | CS | 0..* | CS | |||||||||||||||||||||||
typeId | 0..1 | II | 0..1 | II | |||||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||||||||||||||||||||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||||||||||||||||||||
templateId | 0..* | II | 0..* | II | |||||||||||||||||||||||
classCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: ASSIGNED | 0..1 | ?? | Binding: ?? (required) Fixed Value: ASSIGNED | |||||||||||||||||||||
Slices for id | 1..* | II | Slice: Unordered, Open by value:root | 1..* | II | Slice: Unordered, Open by value:root | |||||||||||||||||||||
sdtcIdentifiedBy | 0..* | IdentifiedBy | XML: identifiedBy (urn:hl7-org:sdtc) | 0..* | IdentifiedBy | 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: ?? (example): See additional bindings
| 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: ?? (example): See additional bindings
| |||||||||||||||||||||
addr | C | 0..* | ?? | Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: 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). 81-10025: 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | C | 0..* | ?? | Required on at least one instance of this author in the document shall-city: SHALL contain exactly one [1..1] city (CONF:81-7292). shall-streetAddressLine: SHALL contain at least one and not more than 4 streetAddressLine (CONF:81-7291). should-use: SHOULD contain @use should-country: SHOULD contain country 81-7296: **SHALL NOT** have mixed content except for white space (CONF:81-7296) 81-10024: 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). 81-10025: 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). shall-max-ad-parts: SHALL have at most one of each: state, city, postalCode, and country | |||||||||||||||||||
telecom | 0..* | TEL | Required on at least one instance of this author in the document | 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 | 0..1 | Person | assignedPerson/name or assignedAuthoringDevice/manufacturerModelName is required on at least one instance of this author in the document | |||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
realmCode | 0..* | CS | 0..* | CS | |||||||||||||||||||||||
typeId | 0..1 | II | 0..1 | II | |||||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||||||||||||||||||||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||||||||||||||||||||
templateId | 0..* | II | 0..* | II | |||||||||||||||||||||||
classCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: PSN | 0..1 | ?? | Binding: ?? (required) Fixed Value: PSN | |||||||||||||||||||||
determinerCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: INSTANCE | 0..1 | ?? | Binding: ?? (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 | C | 1..* | PN | shall-family: SHALL contain exactly one [1..1] family (CONF:81-7159). should-given: SHOULD contain given | |||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
use | 0..* | ?? | Binding: ?? (required) | 0..* | ?? | Binding: ?? (required) | |||||||||||||||||||||
item | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice | C | 1..* | Base | Choice Group: This is a repeating choice group that does not appear directly in the instance EN-1: Can only have only one of the possible item elements in each choice | |||||||||||||||||||
delimiter | 0..* | ENXP | 0..* | ENXP | |||||||||||||||||||||||
family | 0..* | ENXP | Family required | 0..* | ENXP | Family required | |||||||||||||||||||||
given | 0..* | ENXP | SHOULD contain given | 0..* | ENXP | SHOULD contain given | |||||||||||||||||||||
prefix | 0..* | ENXP | 0..* | ENXP | |||||||||||||||||||||||
suffix | 0..* | ENXP | 0..* | ENXP | |||||||||||||||||||||||
xmlText | 0..1 | ?? | Allows for mixed text content | 0..1 | ?? | Allows for mixed text content | |||||||||||||||||||||
validTime | 0..1 | IVL_TS | 0..1 | IVL_TS | |||||||||||||||||||||||
sdtcDesc | 0..1 | ED | XML: desc (urn:hl7-org:sdtc) | 0..1 | ED | XML: desc (urn:hl7-org:sdtc) | |||||||||||||||||||||
sdtcAsPatientRelationship | 0..* | InfrastructureRoot | XML: asPatientRelationship (urn:hl7-org:sdtc) | 0..* | InfrastructureRoot | XML: asPatientRelationship (urn:hl7-org:sdtc) | |||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
realmCode | 0..* | CS | 0..* | CS | |||||||||||||||||||||||
typeId | 0..1 | II | 0..1 | II | |||||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||||||||||||||||||||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||||||||||||||||||||
templateId | 0..* | II | 0..* | II | |||||||||||||||||||||||
classCode | 1..1 | ?? | Fixed Value: PRS | 1..1 | ?? | Fixed Value: PRS | |||||||||||||||||||||
determinerCode | 0..1 | ?? | Fixed Value: INSTANCE | 0..1 | ?? | Fixed Value: INSTANCE | |||||||||||||||||||||
code | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc | 1..1 | CE | XML Namespace: urn:hl7-org:sdtc | |||||||||||||||||||||
assignedAuthoringDevice | 0..1 | AuthoringDevice | 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. | 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. | |||||||||||||||||||
nullFlavor | 0..1 | ?? | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: ?? (required) | 0..1 | ?? | A nullFlavor of "NA" is allowed If the assignedAuthor is not a clinician Binding: ?? (required) | |||||||||||||||||||||
realmCode | 0..* | CS | 0..* | CS | |||||||||||||||||||||||
typeId | 0..1 | II | 0..1 | II | |||||||||||||||||||||||
nullFlavor | 0..1 | ?? | Binding: ?? (required) | 0..1 | ?? | Binding: ?? (required) | |||||||||||||||||||||
assigningAuthorityName | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
displayable | 0..1 | ?? | 0..1 | ?? | |||||||||||||||||||||||
root | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | 1..1 | ??, ??, ?? | Fixed Value: 2.16.840.1.113883.1.3 | |||||||||||||||||||||
st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | 1..1 | string | Primitive Type string URL: http://hl7.org/cda/stds/core/StructureDefinition/st-simple | |||||||||||||||||||||
templateId | 0..* | II | 0..* | II | |||||||||||||||||||||||
classCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: ORG | 0..1 | ?? | Binding: ?? (required) Fixed Value: ORG | |||||||||||||||||||||
determinerCode | 0..1 | ?? | Binding: ?? (required) Fixed Value: INSTANCE | 0..1 | ?? | Binding: ?? (required) Fixed Value: INSTANCE | |||||||||||||||||||||
Slices for id | 0..* | II | Slice: Unordered, Open by value:root | 0..* | II | Slice: Unordered, Open by value:root | |||||||||||||||||||||
name | 0..1 | ON | 0..1 | ON | |||||||||||||||||||||||
telecom | 0..* | TEL | 0..* | TEL | |||||||||||||||||||||||
addr | 0..* | AD | 0..* | AD | |||||||||||||||||||||||
standardIndustryClassCode | 0..1 | CE | Binding: ?? (example) | 0..1 | CE | Binding: ?? (example) | |||||||||||||||||||||
asOrganizationPartOf | 0..1 | OrganizationPartOf | 0..1 | OrganizationPartOf | |||||||||||||||||||||||
Documentation for this format |