Errors and Amendments

The resource with the issue SHOULD have the status changed to the relevant code along with the the DiagnosticReport and Compostion resource as per tables below

Composition vs Canonical Status

Code Display Definition Canonical Status
preliminary Preliminary This is a preliminary composition or document (also known as or interim). The content may be incomplete or unverified. ~draft
final 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
amended 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
entered-in-error 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

DiagnosticReport vs Composition Status

DiagnosticReport status Composition status
registered preliminary
partial preliminary
preliminary preliminary
final final
amended amended
corrected amended
appended amended
cancelled final
entered-in-error entered-in-error
unknown ANY status

A Provenance resource SHALL be added to the document bundle stating the issue and referencing the appropriate resource(s). For multiple issues multiple Provenances SHALL be created.

The Composition.status SHALL be entered within the MNS event under filtering. For example:

{
    "specversion": "1.0",
    "id": "236a1d4a-5d69-4fa9-9c7f-e72bf505aa5b",
    "type": "nhshco-hc-complete-1",
    "subject": "9912003888",
    "filtering": {
      "gppractice": "G12345"
      "status": "entered-in-error"
    },
    "source": "uk.nhs.nhs-health-check-online",
    "time": "2025-04-05T17:31:00.000Z",
    "dataref": "https://int.api.service.nhs.uk/patient-data-manager/FHIR/R4/Composition/b0b97bff-e3d7-4744-a09a-e55781886dd0/$document"
}

Entered in Error

Amendment

Amendment