This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Structured Documents Work Group | Maturity Level: 3 | Trial Use | Use Context: Any |
This is a value set defined by the FHIR project.
Summary
Defining URL: | http://hl7.org/fhir/ValueSet/composition-status |
Version: | 5.0.0-ballot |
Name: | CompositionStatus |
Title: | CompositionStatus |
Status: | draft |
Definition: | The workflow/clinical status of the composition. |
Committee: | Structured Documents Work Group |
OID: | 2.16.840.1.113883.4.642.3.241 (for OID based terminology systems) |
Flags: | Immutable |
This value set is used in the following places:
http://hl7.org/fhir/composition-status
This expansion generated 07 Sep 2022
This value set contains 11 concepts
Expansion based on CompositionStatus v5.0.0-ballot (CodeSystem)
Level | Code | System | Display | Definition | Canonical Mapping for "CompositionStatus" |
1 | registered | http://hl7.org/fhir/composition-status | Registered | The existence of the report is registered, but there is nothing yet available. | ~received |
1 | partial | http://hl7.org/fhir/composition-status | Partial | This is a partial (e.g. initial, interim or preliminary) report: data in the report may be incomplete or unverified. | ~draft |
2 | preliminary | http://hl7.org/fhir/composition-status | Preliminary | Verified early results are available, but not all results are final. | ~draft |
1 | final | http://hl7.org/fhir/composition-status | Final | This version of the composition is complete and verified by an appropriate person and no further work is planned. Any subsequent updates would be on a new version of the composition. | ~complete |
1 | amended | http://hl7.org/fhir/composition-status | Amended | The composition content or the referenced resources have been modified (edited or added to) subsequent to being released as "final" and the composition is complete and verified by an authorized person. | ~replaced |
2 | corrected | http://hl7.org/fhir/composition-status | Corrected | Subsequent to being final, the composition content has been modified to correct an error in the report or referenced results. | ~replaced |
2 | appended | http://hl7.org/fhir/composition-status | Appended | Subsequent to being final, the composition content has been modified by adding new content. The existing content is unchanged. | ~replaced |
1 | cancelled | http://hl7.org/fhir/composition-status | Cancelled | The composition is unavailable because the measurement was not started or not completed (also sometimes called "aborted"). | ~abandoned |
1 | entered-in-error | http://hl7.org/fhir/composition-status | Entered in Error | The composition or document was originally created/issued in error, and this is an amendment that marks that the entire series should not be considered as valid. | ~error |
1 | deprecated | http://hl7.org/fhir/composition-status | Deprecated | This composition has been withdrawn or superseded and should no longer be used. | ~failed |
1 | unknown | http://hl7.org/fhir/composition-status | Unknown | The authoring/source system does not know which of the status values currently applies for this observation. Note: This concept is not to be used for "other" - one of the listed statuses is presumed to apply, but the authoring/source system does not know which. | ~unknown |
See the full registry of value sets defined as part of FHIR.
Explanation of the columns that may appear on this page:
Lvl | A few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information |
Source | The source of the definition of the code (when the value set draws in codes defined elsewhere) |
Code | The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract') |
Display | The display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application |
Definition | An explanation of the meaning of the concept |
Comments | Additional notes about how to use the code |