Extension-DataStandardsWales-DocumentAttribute
An extension to capture attributes of a document that are not explicitly addressed within DocumentReference. Intended for use by exception only to capture data important for specific document types e.g.clinical trial code for cancer-related documents. May be used more extensively for legacy documents.
Purpose
This extension extends the DocumentReference resource to capture document metadata that is not represented by elements of the DocumentReference resource or its referenced resources. The list of attributes is constrained to avoid proliferation of unstructured document emtadata.
Context of Use
This extension may be used on the following profile(s):
- DocumentReference
Formal Views of Extension Content
- Snapshot View
- Example View
| ExtensionDataStandardsWalesDocumentAttribute (Extension) | C | Extension | Element idExtensionShort description Additional metadata for the document DefinitionAdditional metadata as applicable to the document type. This element should be used with care to avoid a proliferation of undefined metadata. The cardinality or value of this element may be affected by these constraints: ele-1 Constraints
| |
| id | 0..1 | string | There are no (further) constraints on this element Element idExtension.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | C | 1..* | Extension | Element idExtension.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. Included for legacy data not explicitly handled via DocumentReference and related resources. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| attributeName | C | 1..1 | Extension | Element idExtension.extension:attributeNameShort description The name code for the document attribute. Alternate namesextensions, user content DefinitionA formal descriptive code for the document attribute e.g. ShareWithReferrer. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idExtension.extension:attributeName.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idExtension.extension:attributeName.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | Element idExtension.extension:attributeName.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. attributeNameMappings
| |
| value[x] | 0..1 | Binding | Element idExtension.extension:attributeName.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list). User-readable semantic codes for allowed attributes. Based on document metadata data held as document attributes in the Welsh Care Records Service and not represented via dedicated elements. FHIRStandardsWalesDocumentAttribute (required) Constraints
| |
| valueCode | code | Data type | ||
| attributeValue | C | 0..1 | Extension | Element idExtension.extension:attributeValueShort description The value recorded against the document attribute. Alternate namesextensions, user content DefinitionThe value recorded against the document attribute. This is modelled as a string format for flexibility. The actual datatype of the value will depend upon the specific document attribute. For example some may be dates, other integers and others a fixed list of codes. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idExtension.extension:attributeValue.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idExtension.extension:attributeValue.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | Element idExtension.extension:attributeValue.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. attributeValueMappings
| |
| value[x] | 1..1 | There are no (further) constraints on this element Element idExtension.extension:attributeValue.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | Data type | ||
| attributeNamespace | C | 0..1 | Extension | Element idExtension.extension:attributeNamespaceShort description The namespace associated with the document attribute value. Alternate namesextensions, user content DefinitionThe namespace associated with the document attribute value where relevant for the specific document attribute. Note that for some attributes namespace may vary according to value domain. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idExtension.extension:attributeNamespace.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idExtension.extension:attributeNamespace.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | Element idExtension.extension:attributeNamespace.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. attributeNamespaceMappings
| |
| value[x] | 0..1 | There are no (further) constraints on this element Element idExtension.extension:attributeNamespace.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | Data type | ||
| valueDomain | C | 0..1 | Extension | Element idExtension.extension:valueDomainShort description The specific domain to which the value of the document attribute belongs. Alternate namesextensions, user content DefinitionSome document attributes contain different sets of values for a pre-defined set of domains. In this case, the value domain provides the context for the value, to provide an unambiguous meaning. 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.
|
| id | 0..1 | string | There are no (further) constraints on this element Element idExtension.extension:valueDomain.idShort description Unique id for inter-element referencing DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
| |
| extension | C | 0..0 | Extension | There are no (further) constraints on this element Element idExtension.extension:valueDomain.extensionShort description Additional content defined by implementations Alternate namesextensions, user content DefinitionMay 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. 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. Unordered, Open, by url(Value) Extensions are always sliced by (at least) url Constraints
|
| url | 1..1 | uriFixed Value | Element idExtension.extension:valueDomain.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. valueDomainMappings
| |
| value[x] | 0..1 | There are no (further) constraints on this element Element idExtension.extension:valueDomain.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
| ||
| valueString | string | Data type | ||
| url | 1..1 | uriFixed Value | Element idExtension.urlShort description identifies the meaning of the extension DefinitionSource of the definition for the extension code - a logical name or a URL. 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. https://fhir.nhs.wales/StructureDefinition/Extension-DataStandardsWales-DocumentAttributeMappings
| |
| value[x] | 0..0 | There are no (further) constraints on this element Element idExtension.value[x]Short description Value of extension DefinitionValue of extension - must be one of a constrained set of the data types (see Extensibility for a list).
|