Wales FHIR Implementation Guide

Extension-DataStandardsWales-DocumentErrorStatus

An extension to capture the error status of a document

Purpose

This extension extends the DocumentReference resource to capture the distinct error status that applies to a document "entered-in-error", which may need to be considered by applications retrieving the document to influence its display and processing options. It distinguishes between documents that are potentially misfiled, documents confirmed as misfiled and documents explicitly revoked.

Context of Use

This extension may be used on the following profile(s):

DocumentReference

Formal Views of Extension Content

Snapshot View
Example View

ExtensionDataStandardsWalesDocumentErrorStatus (Extension)	C		Extension	Element id Extension Short description Document error status Definition An extension to carry a descriptive code for the document error status e.g. potential-misfile. The error status can be used by systems to affect document handling and presentation e.g. watermarking. Data type Extension Conditions The cardinality or value of this element may be affected by these constraints: ele-1 Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a rim: N/A
id		0..1	string	There are no (further) constraints on this element Element id Extension.id Short description Unique id for inter-element referencing Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. Data type string Mappings rim: n/a
extension	C	0..0	Extension	There are no (further) constraints on this element Element id Extension.extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()` Mappings rim: n/a
url		1..1	uriFixed Value	Element id Extension.url Short description identifies the meaning of the extension Definition Source of the definition for the extension code - a logical name or a URL. Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension. Data type uri Fixed value https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DocumentErrorStatus Mappings rim: N/A
value[x]		1..1	Binding	Element id Extension.value[x] Short description revoked \| potential-misfile \| misfiled Definition A descriptive code for the document error status. Binding FHIRStandardsWalesDocumentErrorStatus (required) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` Mappings rim: N/A
valueCode			code	Data type code
id		0..1	string	There are no (further) constraints on this element Element id Extension.value[x].id Short description xml:id (or equivalent in JSON) Definition unique id for the element within a resource (for internal references) Data type string
extension	C	0..0	Extension	Element id Extension.value[x].extension Short description Additional content defined by implementations Alternate names extensions, user content Definition May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. Data type Extension Slicing Unordered, Open, by url(Value) Constraints ele-1: All FHIR elements must have a @value or children `hasValue() or (children().count() > id.count())` ext-1: Must have either extensions or value[x], not both `extension.exists() != value.exists()`
value		0..1	System.String	There are no (further) constraints on this element Element id Extension.value[x].value Short description Primitive value for code Definition Primitive value for code Data type System.String

Currently under development