Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA)
4.0.0-ballot - STU4
Consolidated CDA (C-CDA), published by Health Level Seven. This guide is not an authorized publication; it is the continuous build for version 4.0.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/CDA-ccda/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/cda/us/ccda/StructureDefinition/ResultOrganizer | Version: 4.0.0-ballot | |||
| Draft as of 2024-11-21 | Computable Name: ResultOrganizer | |||
| Other Identifiers: urn:ietf:rfc:3986#Uniform Resource Identifier (URI)#urn:hl7ii:2.16.840.1.113883.10.20.22.4.1:2023-05-01 | ||||
This template provides a mechanism for grouping result observations. It contains information applicable to all of the contained result observations. The Result Organizer code categorizes the contained results into one of several commonly accepted values (e.g., Hematology, Chemistry, Nuclear Medicine).
If any Result Observation within the organizer has a statusCode of "active", the Result Organizer must also have a statusCode of "active".
A specimen linked to a Result Organizer applies to all Result Observations. Centralizing specimen details within the Organizer is advised for clarity and consistency, as Result Observations typically relate to a single specimen collection, like using a purple top tube for CBCs. In cases of poor-quality specimens, a specimen reject reason is logically associated with the procedure, not the result, as there may be no result. The Result Organizer includes the specimen collection procedure, which may contain information about specimen condition acceptability. The Specimen Colection Procedure includes representation of the USCDI data element "Specimen Condition Acceptability".
The Result Organizer template is a versatile template designed to represent any type of finding resulting from various types of tests. Value set bindings for Observation.code have been created to support implementers, covering three categories: 1) Common Laboratory Tests, 2) Radiology Tests, and 3) Clinical Tests. If a suitable code is not available within these value sets, first use another LOINC code. If no LOINC code is appropriate, a local code may be used.
Usage:
Description of Template, Differentials, Snapshots and how the different presentations work.
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
  Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |||||||||||||
   templateId:result-org |
1..1 | II | ||||||||||||||
  @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.1 | |||||||||||||
  @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
 @classCode |
1..1 | cs | ||||||||||||||
| @moodCode |
1..1 | cs | ||||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||||||||||||
 reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| statusCode |
1..1 | CS | ||||||||||||||
| @nullFlavor |
0..0 | |||||||||||||||
| @code |
1..1 | cs | Binding: Result Status  (required) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code. | |||||||||||||
 specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| id |
1..* | II | ||||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
 author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
 component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
 observation |
1..1 | ResultObservation | Base for all types and resources | |||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| procedure |
1..1 | SpecimenCollectionProcedure | Base for all types and resources | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |||||||||||||
| templateId:result-org |
1..1 | II | ||||||||||||||
 @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.1 | |||||||||||||
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) | |||||||||||||
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |||||||||||||
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |||||||||||||
| @code |
1..1 | cs | Binding: Result Status (required) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code. | |||||||||||||
| specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| id |
1..* | II | ||||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
| author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
| component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
| observation |
C | 1..1 | ResultObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-interpretationCode: SHOULD contain interpretationCode should-author: SHOULD contain author should-referenceRange: SHOULD contain referenceRange | ||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| procedure |
C | 1..1 | SpecimenCollectionProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.classCode | required | XActClassDocumentEntryOrganizerhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-author | warning | Organizer.component:resultObs.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:specimenProc.procedure | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-interpretationCode | warning | Organizer.component:resultObs.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
| should-referenceRange | warning | Organizer.component:resultObs.observation | SHOULD contain referenceRange : referenceRange.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:specimenProc.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:resultObs.observation, Organizer.component:specimenProc.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
| @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:result-org |
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.4.1 | |||||||||||||
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) | |||||||||||||
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |||||||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||||||||
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |||||||||||||
| @integrityCheck |
0..1 | bin | ||||||||||||||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |||||||||||||
| @language |
0..1 | cs | ||||||||||||||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |||||||||||||
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |||||||||||||
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |||||||||||||
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| thumbnail |
0..1 | ED | ||||||||||||||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |||||||||||||
| @code |
1..1 | cs | Binding: Result Status (required) | |||||||||||||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |||||||||||||
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||||||||
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |||||||||||||
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| center |
0..1 | TS | ||||||||||||||
| width |
0..1 | PQ | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| subject |
0..1 | Subject | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: SPC | |||||||||||||
| specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| @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: RoleClassSpecimen (required) Fixed Value: SPEC | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| @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: EntityClassRoot (required) | |||||||||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
| quantity |
0..* | PQ | ||||||||||||||
| name |
0..* | PN | ||||||||||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||||||||
| desc |
0..1 | ED | ||||||||||||||
| performer |
0..* | Performer2 | ||||||||||||||
| author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| informant |
0..* | Informant | ||||||||||||||
| participant |
0..* | Participant2 | ||||||||||||||
| reference |
0..* | Reference | ||||||||||||||
| precondition |
0..* | Precondition | ||||||||||||||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
| component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
| @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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |||||||||||||
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |||||||||||||
| sequenceNumber |
0..1 | INT | ||||||||||||||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |||||||||||||
| seperatableInd |
0..1 | BL | ||||||||||||||
| act |
0..1 | Act | ||||||||||||||
| encounter |
0..1 | Encounter | ||||||||||||||
| observation |
C | 1..1 | ResultObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-interpretationCode: SHOULD contain interpretationCode should-author: SHOULD contain author should-referenceRange: SHOULD contain referenceRange | ||||||||||||
| observationMedia |
0..1 | ObservationMedia | ||||||||||||||
| organizer |
0..1 | Organizer | ||||||||||||||
| procedure |
0..1 | Procedure | ||||||||||||||
| regionOfInterest |
0..1 | RegionOfInterest | ||||||||||||||
| substanceAdministration |
0..1 | SubstanceAdministration | ||||||||||||||
| supply |
0..1 | Supply | ||||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| @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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |||||||||||||
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |||||||||||||
| sequenceNumber |
0..1 | INT | ||||||||||||||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |||||||||||||
| seperatableInd |
0..1 | BL | ||||||||||||||
| act |
0..1 | Act | ||||||||||||||
| encounter |
0..1 | Encounter | ||||||||||||||
| observation |
0..1 | Observation | ||||||||||||||
| observationMedia |
0..1 | ObservationMedia | ||||||||||||||
| organizer |
0..1 | Organizer | ||||||||||||||
| procedure |
C | 1..1 | SpecimenCollectionProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode | ||||||||||||
| regionOfInterest |
0..1 | RegionOfInterest | ||||||||||||||
| substanceAdministration |
0..1 | SubstanceAdministration | ||||||||||||||
| supply |
0..1 | Supply | ||||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.templateId:result-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.classCode | required | XActClassDocumentEntryOrganizerhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Organizer.specimen.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.typeCode | required | Fixed Value: SPChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Organizer.specimen.specimenRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.classCode | required | Fixed Value: SPEChttp://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 | |
| Organizer.component:resultObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:resultObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:resultObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
| Organizer.component:specimenProc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:specimenProc.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:specimenProc.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-author | warning | Organizer.component:resultObs.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:specimenProc.procedure | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-interpretationCode | warning | Organizer.component:resultObs.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
| should-referenceRange | warning | Organizer.component:resultObs.observation | SHOULD contain referenceRange : referenceRange.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:specimenProc.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:resultObs.observation, Organizer.component:specimenProc.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements(6 nested mandatory elements)
Prohibited: 1 element
Structures
This structure refers to these other structures:
Slices
This structure defines the following Slices:
Differential View
This structure is derived from Organizer
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |||||||||||||
| templateId:result-org |
1..1 | II | ||||||||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.1 | |||||||||||||
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
| @classCode |
1..1 | cs | ||||||||||||||
| @moodCode |
1..1 | cs | ||||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | SHOULD reference the portion of section narrative text corresponding to this entry | |||||||||||||
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| statusCode |
1..1 | CS | ||||||||||||||
| @nullFlavor |
0..0 | |||||||||||||||
| @code |
1..1 | cs | Binding: Result Status (required) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code. | |||||||||||||
| specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| id |
1..* | II | ||||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
| author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
| component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
| observation |
1..1 | ResultObservation | Base for all types and resources | |||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| procedure |
1..1 | SpecimenCollectionProcedure | Base for all types and resources | |||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet | URI |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
| Slices for templateId |
1..* | II | Slice: Unordered, Open by value:root, value:extension | |||||||||||||
| templateId:result-org |
1..1 | II | ||||||||||||||
| @root |
1..1 | oid, uuid, ruid | Required Pattern: 2.16.840.1.113883.10.20.22.4.1 | |||||||||||||
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) | |||||||||||||
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |||||||||||||
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |||||||||||||
| @code |
1..1 | cs | Binding: Result Status (required) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/code. | |||||||||||||
| specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| id |
1..* | II | ||||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
| author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
| component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
| observation |
C | 1..1 | ResultObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-interpretationCode: SHOULD contain interpretationCode should-author: SHOULD contain author should-referenceRange: SHOULD contain referenceRange | ||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| procedure |
C | 1..1 | SpecimenCollectionProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode | ||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.classCode | required | XActClassDocumentEntryOrganizerhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-author | warning | Organizer.component:resultObs.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:specimenProc.procedure | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-interpretationCode | warning | Organizer.component:resultObs.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
| should-referenceRange | warning | Organizer.component:resultObs.observation | SHOULD contain referenceRange : referenceRange.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:specimenProc.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:resultObs.observation, Organizer.component:specimenProc.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Organizer |
C | 1..1 | Organizer | XML Namespace: urn:hl7-org:v3 Elements defined in Ancestors:@nullFlavor, realmCode, typeId, templateId, @classCode, @moodCode, id, sdtcCategory, code, sdtcText, statusCode, effectiveTime, subject, specimen, performer, author, informant, participant, reference, precondition, sdtcPrecondition2, component Base for all types and resources Instance of this type are validated by templateId Logical Container: ClinicalDocument (CDA Class) should-sdtctext-ref-value: SHOULD contain text/reference/@value should-sdtcCategory: SHOULD contain sdtcCategory should-author: SHOULD contain author | ||||||||||||
| @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:result-org |
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.4.1 | |||||||||||||
| @extension |
1..1 | st | Required Pattern: 2023-05-01 | |||||||||||||
| @classCode |
1..1 | cs | Binding: XActClassDocumentEntryOrganizer (2.0.0) (required) | |||||||||||||
| @moodCode |
1..1 | cs | Binding: CDAActMood (required) Fixed Value: EVN | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcCategory |
0..1 | CD | XML Namespace: urn:hl7-org:sdtc XML: category (urn:hl7-org:sdtc) Binding: DiagnosticServiceSectionCodes (preferred) | |||||||||||||
| code |
C | 1..1 | CD | Binding: v3 Code System ActCode (example)
4537-19218: **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). | ||||||||||||
| sdtcText |
0..1 | ED | XML Namespace: urn:hl7-org:sdtc SHOULD reference the portion of section narrative text corresponding to this entry XML: text (urn:hl7-org:sdtc) | |||||||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||||||||
| @compression |
0..1 | cs | Binding: CDACompressionAlgorithm (required) | |||||||||||||
| @integrityCheck |
0..1 | bin | ||||||||||||||
| @integrityCheckAlgorithm |
0..1 | cs | Binding: IntegrityCheckAlgorithm (2.0.0) (required) | |||||||||||||
| @language |
0..1 | cs | ||||||||||||||
| @mediaType |
0..1 | cs | Binding: MediaType (example) | |||||||||||||
| @representation |
0..1 | cs | Binding: CDABinaryDataEncoding (required) | |||||||||||||
| xmlText |
0..1 | st | Allows for mixed text content. If @representation='B64', this SHALL be a base64binary string. | |||||||||||||
| reference |
C | 0..1 | TEL | value-starts-octothorpe: If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative | ||||||||||||
| thumbnail |
0..1 | ED | ||||||||||||||
| statusCode |
1..1 | CS | Binding: ActStatus (required) | |||||||||||||
| @code |
1..1 | cs | Binding: Result Status (required) | |||||||||||||
| @sdtcValueSet |
0..1 | oid | XML Namespace: urn:hl7-org:sdtc XML: valueSet (urn:hl7-org:sdtc) | |||||||||||||
| @sdtcValueSetVersion |
0..1 | st | XML Namespace: urn:hl7-org:sdtc XML: valueSetVersion (urn:hl7-org:sdtc) | |||||||||||||
| effectiveTime |
0..1 | IVL_TS | The effectiveTime is an interval that spans the effectiveTimes of the contained result observations. Because all contained result observations have a required time stamp, it is not required that this effectiveTime be populated. | |||||||||||||
| @nullFlavor |
0..1 | cs | Binding: CDANullFlavor (required) | |||||||||||||
| @value |
0..1 | ts | Date Format: YYYYMMDDHHMMSS.UUUU[+|-ZZzz] | |||||||||||||
| @operator |
0..1 | cs | Binding: CDASetOperator (required) | |||||||||||||
| low |
1..1 | IVXB_TS | ||||||||||||||
| center |
0..1 | TS | ||||||||||||||
| width |
0..1 | PQ | ||||||||||||||
| high |
1..1 | IVXB_TS | ||||||||||||||
| subject |
0..1 | Subject | ||||||||||||||
| specimen |
0..* | Specimen | When an organizer is for laboratory, observations are expected to include the specimen participant. The specimen included at specimenPlayingEntity/code must be consistent with the observation/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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: CDAParticipationType (required) Fixed Value: SPC | |||||||||||||
| specimenRole |
1..1 | SpecimenRole | 𝗨𝗦𝗖𝗗𝗜: Specimen Identifier | |||||||||||||
| @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: RoleClassSpecimen (required) Fixed Value: SPEC | |||||||||||||
| id |
1..* | II | ||||||||||||||
| sdtcIdentifiedBy |
0..* | IdentifiedBy | XML Namespace: urn:hl7-org:sdtc XML: identifiedBy (urn:hl7-org:sdtc) | |||||||||||||
| specimenPlayingEntity |
1..1 | PlayingEntity | 𝗨𝗦𝗖𝗗𝗜: Specimen Type | |||||||||||||
| @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: EntityClassRoot (required) | |||||||||||||
| @determinerCode |
0..1 | cs | Binding: EntityDeterminer (required) Fixed Value: INSTANCE | |||||||||||||
| code |
1..1 | CE | Binding: Specimen type (preferred) | |||||||||||||
| quantity |
0..* | PQ | ||||||||||||||
| name |
0..* | PN | ||||||||||||||
| sdtcBirthTime |
0..1 | TS | XML Namespace: urn:hl7-org:sdtc XML: birthTime (urn:hl7-org:sdtc) | |||||||||||||
| desc |
0..1 | ED | ||||||||||||||
| performer |
0..* | Performer2 | ||||||||||||||
| author |
0..* | AuthorParticipation | Base for all types and resources | |||||||||||||
| informant |
0..* | Informant | ||||||||||||||
| participant |
0..* | Participant2 | ||||||||||||||
| reference |
0..* | Reference | ||||||||||||||
| precondition |
0..* | Precondition | ||||||||||||||
| sdtcPrecondition2 |
0..* | Precondition2 | XML Namespace: urn:hl7-org:sdtc XML: precondition2 (urn:hl7-org:sdtc) | |||||||||||||
| Slices for component |
1..* | OrganizerComponent | Slice: Unordered, Open by profile:observation, profile:procedure | |||||||||||||
| component:resultObs |
1..* | OrganizerComponent | 𝗨𝗦𝗖𝗗𝗜: Values/Results | |||||||||||||
| @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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |||||||||||||
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |||||||||||||
| sequenceNumber |
0..1 | INT | ||||||||||||||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |||||||||||||
| seperatableInd |
0..1 | BL | ||||||||||||||
| act |
0..1 | Act | ||||||||||||||
| encounter |
0..1 | Encounter | ||||||||||||||
| observation |
C | 1..1 | ResultObservation | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-interpretationCode: SHOULD contain interpretationCode should-author: SHOULD contain author should-referenceRange: SHOULD contain referenceRange | ||||||||||||
| observationMedia |
0..1 | ObservationMedia | ||||||||||||||
| organizer |
0..1 | Organizer | ||||||||||||||
| procedure |
0..1 | Procedure | ||||||||||||||
| regionOfInterest |
0..1 | RegionOfInterest | ||||||||||||||
| substanceAdministration |
0..1 | SubstanceAdministration | ||||||||||||||
| supply |
0..1 | Supply | ||||||||||||||
| component:specimenProc |
0..1 | OrganizerComponent | (USCDI) Specimen Condition Acceptability | |||||||||||||
| @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 | ||||||||||||||
| @typeCode |
0..1 | cs | Binding: ActRelationshipHasComponent (required) | |||||||||||||
| @contextConductionInd |
0..1 | bl | Fixed Value: true | |||||||||||||
| sequenceNumber |
0..1 | INT | ||||||||||||||
| sdtcPriorityNumber |
0..1 | INT | XML Namespace: urn:hl7-org:sdtc XML: priorityNumber (urn:hl7-org:sdtc) | |||||||||||||
| seperatableInd |
0..1 | BL | ||||||||||||||
| act |
0..1 | Act | ||||||||||||||
| encounter |
0..1 | Encounter | ||||||||||||||
| observation |
0..1 | Observation | ||||||||||||||
| observationMedia |
0..1 | ObservationMedia | ||||||||||||||
| organizer |
0..1 | Organizer | ||||||||||||||
| procedure |
C | 1..1 | SpecimenCollectionProcedure | Base for all types and resources should-text-ref-value: SHOULD contain text/reference/@value should-effectiveTime: SHOULD contain effectiveTime should-targetSiteCode: SHOULD contain targetSiteCode | ||||||||||||
| regionOfInterest |
0..1 | RegionOfInterest | ||||||||||||||
| substanceAdministration |
0..1 | SubstanceAdministration | ||||||||||||||
| supply |
0..1 | Supply | ||||||||||||||
| Documentation for this format | ||||||||||||||||
| Path | Conformance | ValueSet / Code | URI |
| Organizer.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.templateId:result-org.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.classCode | required | XActClassDocumentEntryOrganizerhttp://terminology.hl7.org/ValueSet/v3-xActClassDocumentEntryOrganizer|2.0.0 | |
| Organizer.moodCode | required | Fixed Value: EVNhttp://hl7.org/cda/stds/core/ValueSet/CDAActMood | |
| Organizer.sdtcCategory | preferred | DiagnosticServiceSectionCodeshttp://hl7.org/fhir/ValueSet/diagnostic-service-sectionsfrom the FHIR Standard | |
| Organizer.code | example | ActCodehttp://terminology.hl7.org/ValueSet/v3-ActCode | |
| Organizer.sdtcText.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.sdtcText.compression | required | CDACompressionAlgorithmhttp://hl7.org/cda/stds/core/ValueSet/CDACompressionAlgorithm | |
| Organizer.sdtcText.integrityCheckAlgorithm | required | IntegrityCheckAlgorithmhttp://terminology.hl7.org/ValueSet/v3-IntegrityCheckAlgorithm|2.0.0 | |
| Organizer.sdtcText.mediaType | example | MediaTypehttp://terminology.hl7.org/ValueSet/v3-MediaType | |
| Organizer.sdtcText.representation | required | BinaryDataEncodinghttp://hl7.org/cda/stds/core/ValueSet/BinaryDataEncoding | |
| Organizer.statusCode | required | ActStatushttp://terminology.hl7.org/ValueSet/v3-ActStatus | |
| Organizer.statusCode.code | required | ResultStatus http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113883.11.20.9.39 | |
| Organizer.effectiveTime.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.effectiveTime.operator | required | CDASetOperatorhttp://hl7.org/cda/stds/core/ValueSet/CDASetOperator | |
| Organizer.specimen.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.typeCode | required | Fixed Value: SPChttp://hl7.org/cda/stds/core/ValueSet/CDAParticipationType | |
| Organizer.specimen.specimenRole.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.classCode | required | Fixed Value: SPEChttp://terminology.hl7.org/ValueSet/v3-RoleClassSpecimen | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.classCode | required | EntityClassRoothttp://terminology.hl7.org/ValueSet/v3-EntityClassRoot | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.determinerCode | required | Fixed Value: INSTANCEhttp://terminology.hl7.org/ValueSet/v3-EntityDeterminer | |
| Organizer.specimen.specimenRole.specimenPlayingEntity.code | preferred | SpecimenType http://cts.nlm.nih.gov/fhir/ValueSet/2.16.840.1.113762.1.4.1099.54 | |
| Organizer.component:resultObs.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:resultObs.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:resultObs.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent | |
| Organizer.component:specimenProc.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:specimenProc.typeId.nullFlavor | required | CDANullFlavorhttp://hl7.org/cda/stds/core/ValueSet/CDANullFlavor | |
| Organizer.component:specimenProc.typeCode | required | ActRelationshipHasComponenthttp://terminology.hl7.org/ValueSet/v3-ActRelationshipHasComponent |
| Id | Grade | Path(s) | Details | Requirements |
| 4537-19218 | warning | Organizer.code | **SHOULD** be selected from LOINC (codeSystem 2.16.840.1.113883.6.1) **OR** SNOMED CT (codeSystem 2.16.840.1.113883.6.96), and **MAY** be selected from CPT (codeSystem 2.16.840.1.113883.6.12) (CONF:4537-19218). : codeSystem = '2.16.840.1.113883.6.1' or codeSystem = '2.16.840.1.113883.6.96' | |
| should-author | warning | Organizer | SHOULD contain author : author.exists() | |
| should-author | warning | Organizer.component:resultObs.observation | SHOULD contain author : author.exists() | |
| should-effectiveTime | warning | Organizer.component:specimenProc.procedure | SHOULD contain effectiveTime : effectiveTime.exists() | |
| should-interpretationCode | warning | Organizer.component:resultObs.observation | SHOULD contain interpretationCode : interpretationCode.exists() | |
| should-referenceRange | warning | Organizer.component:resultObs.observation | SHOULD contain referenceRange : referenceRange.exists() | |
| should-sdtcCategory | warning | Organizer | SHOULD contain sdtcCategory : sdtcCategory.exists() | |
| should-sdtctext-ref-value | warning | Organizer | SHOULD contain text/reference/@value : sdtcText.reference.value.exists() | |
| should-targetSiteCode | warning | Organizer.component:specimenProc.procedure | SHOULD contain targetSiteCode : targetSiteCode.exists() | |
| should-text-ref-value | warning | Organizer.component:resultObs.observation, Organizer.component:specimenProc.procedure | SHOULD contain text/reference/@value : text.reference.value.exists() | |
| value-starts-octothorpe | error | Organizer.sdtcText.reference | If reference/@value is present, it SHALL begin with a '#' and SHALL point to its corresponding narrative : value.exists() implies value.startsWith('#') |
This structure is derived from Organizer
Summary
Mandatory: 10 elements(6 nested mandatory elements)
Prohibited: 1 element
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#4.0.0-ballot based on FHIR 5.0.0. Generated 2024-11-21
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change