Name Flags Card. Type Description & Constraints Participant1 1..1 Participant1 XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors: @nullFlavor, realmCode, <a href="http://hl7.org/cda/stds/core/2.0.0-sd-snapshot1/StructureDefinition-InfrastructureRoot.html" title="When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.">typeId, templateId, @typeCode, @contextControlCode, functionCode, time, associatedEntity 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-assembler 1..1 II @root 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.10.20.22.5.7 @extension 1..1 st Required Pattern: 2020-05-19 @typeCode 1..1 cs Fixed Value: DEV functionCode 1..1 CE @code 1..1 cs Required Pattern: assembler @codeSystem 1..1 oid, uuid, ruid Required Pattern: 2.16.840.1.113883.4.642.4.1131 time 1..1 IVL_TS associatedEntity 1..1 AssociatedEntity The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization. @classCode 1..1 cs Fixed Value: OWN scopingOrganization C 1..1 Organization should-telecom: SHOULD contain telecom should-addr: SHOULD contain addr id 1..* II name 1..* ON telecom 0..* TEL addr 0..* USRealmAddress Base for all types and resources Documentation for this format
HL7 International - Structured Documents
This template represents the organization that supported generation of a CDA document. The Assembler Organization may be different than the Author Organization, and may be different from the Organization that developed the software used to generate the document. This Participation is only for use in the CDA Header because it applies to the entire content in the document. This template is consistent with the prior Assembler Document Participant (2.16.840.1.113883.3.5019.1.1) in the 2016 HL7 Data Provenance guide, however, makes no claim about representing the software organization. All constraints for conformance are defined in this template. Note: The CDA Participant does not support a software device or the organization that created the software. The Assembler role can only be expressed at the level of organization. This is a known issue with the current CDA R2 model. Note: The Provenance template title includes a version 2 to support moving from the 'Basic Provenance' guide to the this Companion Guide, so the templateId has not changed.
Defines the basic properties of every data value. This is an abstract type, meaning that no value can be just a data value without belonging to any concrete type. Every concrete type is a specialization of this general abstract DataValue type.
If a value is an exceptional value (NULL-value), this specifies in what way and why proper information is missing.
When valued in an instance, this attribute signals the imposition of realm-specific constraints. The value of this attribute identifies the realm in question
When valued in an instance, this attribute signals the imposition of constraints defined in an HL7-specified message type. This might be a common type (also known as CMET in the messaging communication environment), or content included within a wrapper. The value of this attribute provides a unique identifier for the type in question.
A human readable name or mnemonic for the assigning authority. The Assigning Authority Name has no computational value. The purpose of a Assigning Authority Name is to assist an unaided human interpreter of an II value to interpret the authority. Note: no automated processing must depend on the assigning authority name to be present in any form.
Specifies if the identifier is intended for human display and data entry (displayable = true) as opposed to pure machine interoperation (displayable = false).
Identifies the type as an HL7 Registered model
A character string as a unique identifier within the scope of the identifier root.
When valued in an instance, this attribute signals the imposition of a set of template-defined constraints. The value of this attribute provides a unique identifier for the templates in question
A unique identifier that guarantees the global uniqueness of the instance identifier. The root alone may be the entire instance identifier.
SHALL contain exactly one [1..1] @typeCode="DEV" Device (CONF:4537-55).
SHALL contain exactly one [1..1] functionCode (CONF:4537-38).
The plain code symbol defined by the code system. For example, "784.0" is the code symbol of the ICD-9 code "784.0" for headache.
This functionCode SHALL contain exactly one [1..1] @code="assembler" Assembler (CONF:4537-32972).
Specifies the code system that defines the code.
This functionCode SHALL contain exactly one [1..1] @codeSystem (CodeSystem: ProvenanceParticipantType urn:oid:2.16.840.1.113883.4.642.4.1131) (CONF:4537-41).
If applicable, a version descriptor defined specifically for the given code system.
A name or title for the code, under which the sending system shows the code value to its users.
The valueSet extension adds an attribute for elements with a CD dataType which indicates the particular value set constraining the coded concept.
The valueSetVersion extension adds an attribute for elements with a CD dataType which indicates the version of the particular value set constraining the coded concept.
The text or phrase used as the basis for the coding.
Specifies additional codes that increase the specificity of the the primary code.
A set of other concept descriptors that translate this concept descriptor into other code systems.
SHALL contain exactly one [1..1] time (CONF:4537-42).
The template does not require any elements from the associatedEntity since the information is recorded in the scopingOrganization.
SHALL contain exactly one [1..1] associatedEntity (CONF:4537-39).
This associatedEntity SHALL contain exactly one [1..1] @classCode="OWN" Owned Entity (CONF:4537-32973).
This associatedEntity SHALL contain exactly one [1..1] scopingOrganization (CONF:4537-43).
This scopingOrganization SHALL contain at least one [1..*] id (CONF:4537-50).
This scopingOrganization SHALL contain at least one [1..*] name (CONF:4537-51).
This scopingOrganization SHOULD contain zero or more [0..*] telecom (CONF:4537-52).
Mailing and home or office addresses. A sequence of address parts, such as street or post office Box, city, postal code, country, etc.
This scopingOrganization SHOULD contain zero or more [0..*] US Realm Address (AD.US.FIELDED) (identifier: urn:oid:2.16.840.1.113883.10.20.22.5.2) (CONF:4537-47).
SHALL contain exactly one [1..1] city (CONF:81-7292).
nullFlavor.exists() or item.city.count() = 1
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)
nullFlavor.exists() or item.country.exists()
**SHALL NOT** have mixed content except for white space (CONF:81-7296)
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'))
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})?'))
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)