LinuxForHealth FHIR Implementation Guide
8.0.0 - draft United States of America flag

LinuxForHealth FHIR Implementation Guide - Local Development build (v8.0.0). See the Directory of published versions

Data Type Profile: ProcessMeta - Detailed Descriptions

Active as of 2022-11-10

Definitions for the process-meta data type profile.

1. Meta
2. Meta.extension:ingestionBatchId
SliceNameingestionBatchId
Definition

The ID generated by an ingestion service. This represents a producer-submitted message collection

Control0..1
TypeExtension(IngestionBatchId) (Extension Type: string)
3. Meta.extension:tenantId
SliceNametenantId
Definition

The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver. This ID must be unique to data sent on behalf of that client or tenant within the data receiver systems. The receiver systems should associate this ID to the messages that originate from this client or tenant. This supports traceability, data protection, and data isolation, when appropriate.

Control0..1
TypeExtension(TenantId) (Extension Type: string)
4. Meta.extension:processClientId
SliceNameprocessClientId
Definition

The ID of the client as recorded in the data producer or data integrator source system(s)

Control0..1
TypeExtension(ProcessClientId) (Extension Type: string)
5. Meta.extension:processOrganization
SliceNameprocessOrganization
Definition

The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service.

Control0..1
TypeExtension(ProcessOrganization) (Extension Type: string)
6. Meta.extension:processName
SliceNameprocessName
Definition

The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service.

Control0..1
TypeExtension(ProcessName) (Extension Type: string)
7. Meta.extension:processVersion
SliceNameprocessVersion
Definition

The version of either the process or the service that has produced the data held in the FHIR resource or element

Control0..1
TypeExtension(ProcessVersion) (Extension Type: string)
8. Meta.extension:processType
SliceNameprocessType
Definition

The classification type of the process that has produced the data held in either the FHIR resource or element

Control0..1
TypeExtension(ProcessType) (Extension Type: string)
9. Meta.extension:processRecordId
SliceNameprocessRecordId
Definition

The record ID that the data producer or data integrator uses internally to identify this data

Control0..*
TypeExtension(ProcessRecordId) (Extension Type: Identifier)
10. Meta.extension:processTimestamp
SliceNameprocessTimestamp
Definition

The timestamp when the data was generated within the FHIR resource or element

Control0..1
TypeExtension(ProcessTimestamp) (Extension Type: dateTime)
11. Meta.extension:sourceRecordId
SliceNamesourceRecordId
Definition

The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element

Control0..*
TypeExtension(SourceRecordId) (Extension Type: string)
12. Meta.extension:sourceFileId
SliceNamesourceFileId
Definition

The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element

Control0..*
TypeExtension(SourceFileId) (Extension Type: string)
13. Meta.extension:sourceRecordType
SliceNamesourceRecordType
Definition

Either the data model type or schema type that generates this FHIR resource

Control0..1
TypeExtension(SourceRecordType) (Extension Type: CodeableConcept)
14. Meta.extension:sourceDataModelVersion
SliceNamesourceDataModelVersion
Definition

Version of the source system's data model, used by either the data producer or the data integrator

Control0..1
TypeExtension(SourceDataModelVersion) (Extension Type: string)
15. Meta.extension:sourceEventTrigger
SliceNamesourceEventTrigger
Definition

The event that is the catalyst for creating or updating this FHIR resource

Control0..1
TypeExtension(SourceEventTrigger) (Extension Type: CodeableConcept)
16. Meta.extension:sourceEventTrigger.valueCodeableConcept
Control0..1
BindingFor example codes, see hl7VS-eventTypeCode
17. Meta.extension:sourceEventTimestamp
SliceNamesourceEventTimestamp
Definition

Date and time of the source event that triggers either the creation or updating of this FHIR resource

Control0..1
TypeExtension(SourceEventTimestamp) (Extension Type: dateTime)
18. Meta.extension:insight
SliceNameinsight
Definition

References element level insight results pertaining to the data in this resource instance.

Control0..*
TypeExtension(Insight) (Complex Extension)
19. Meta.tag
SlicingThis element introduces a set of slices on Meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
20. Meta.tag:SourceClassificationTag
SliceNameSourceClassificationTag
Definition

Identifies the origin of this FHIR resource, from either a source system of record or derived from a process

Control0..1
21. Meta.tag:SourceClassificationTag.system
Control1..?
Pattern Valuehttp://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
22. Meta.tag:SourceClassificationTag.code
Control0..?
BindingThe codes SHALL be taken from Source Classification Value Set
1. Meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..* This element is affected by the following invariants: ele-1
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
2. Meta.extension:ingestionBatchId
SliceNameingestionBatchId
Definition

The ID generated by an ingestion service. This represents a producer-submitted message collection

Control0..1
TypeExtension(IngestionBatchId) (Extension Type: string)
InvariantsDefined on this element
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())
3. Meta.extension:tenantId
SliceNametenantId
Definition

The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver. This ID must be unique to data sent on behalf of that client or tenant within the data receiver systems. The receiver systems should associate this ID to the messages that originate from this client or tenant. This supports traceability, data protection, and data isolation, when appropriate.

Control0..1
TypeExtension(TenantId) (Extension Type: string)
InvariantsDefined on this element
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())
4. Meta.extension:processClientId
SliceNameprocessClientId
Definition

The ID of the client as recorded in the data producer or data integrator source system(s)

Control0..1
TypeExtension(ProcessClientId) (Extension Type: string)
InvariantsDefined on this element
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())
5. Meta.extension:processOrganization
SliceNameprocessOrganization
Definition

The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service.

Control0..1
TypeExtension(ProcessOrganization) (Extension Type: string)
InvariantsDefined on this element
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())
6. Meta.extension:processName
SliceNameprocessName
Definition

The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service.

Control0..1
TypeExtension(ProcessName) (Extension Type: string)
InvariantsDefined on this element
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())
7. Meta.extension:processVersion
SliceNameprocessVersion
Definition

The version of either the process or the service that has produced the data held in the FHIR resource or element

Control0..1
TypeExtension(ProcessVersion) (Extension Type: string)
InvariantsDefined on this element
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())
8. Meta.extension:processType
SliceNameprocessType
Definition

The classification type of the process that has produced the data held in either the FHIR resource or element

Control0..1
TypeExtension(ProcessType) (Extension Type: string)
InvariantsDefined on this element
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())
9. Meta.extension:processRecordId
SliceNameprocessRecordId
Definition

The record ID that the data producer or data integrator uses internally to identify this data

Control0..*
TypeExtension(ProcessRecordId) (Extension Type: Identifier)
InvariantsDefined on this element
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())
10. Meta.extension:processTimestamp
SliceNameprocessTimestamp
Definition

The timestamp when the data was generated within the FHIR resource or element

Control0..1
TypeExtension(ProcessTimestamp) (Extension Type: dateTime)
InvariantsDefined on this element
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())
11. Meta.extension:sourceRecordId
SliceNamesourceRecordId
Definition

The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element

Control0..*
TypeExtension(SourceRecordId) (Extension Type: string)
InvariantsDefined on this element
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())
12. Meta.extension:sourceFileId
SliceNamesourceFileId
Definition

The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element

Control0..*
TypeExtension(SourceFileId) (Extension Type: string)
InvariantsDefined on this element
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())
13. Meta.extension:sourceRecordType
SliceNamesourceRecordType
Definition

Either the data model type or schema type that generates this FHIR resource

Control0..1
TypeExtension(SourceRecordType) (Extension Type: CodeableConcept)
InvariantsDefined on this element
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())
14. Meta.extension:sourceDataModelVersion
SliceNamesourceDataModelVersion
Definition

Version of the source system's data model, used by either the data producer or the data integrator

Control0..1
TypeExtension(SourceDataModelVersion) (Extension Type: string)
InvariantsDefined on this element
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())
15. Meta.extension:sourceEventTrigger
SliceNamesourceEventTrigger
Definition

The event that is the catalyst for creating or updating this FHIR resource

Control0..1
TypeExtension(SourceEventTrigger) (Extension Type: CodeableConcept)
InvariantsDefined on this element
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())
16. Meta.extension:sourceEventTrigger.extension
Definition

An Extension

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.

Control0..0*
TypeExtension
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Meta.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
17. Meta.extension:sourceEventTrigger.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger
18. Meta.extension:sourceEventTrigger.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Meta.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
19. Meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingFor example codes, see hl7VS-eventTypeCodeFor codes, see (unbound)
TypeChoice of: CodeableConcept, date, Meta, Address, Attachment, integer, Count, DataRequirement, Dosage, uuid, Identifier, Coding, SampledData, id, positiveInt, Distance, Period, Duration, canonical, Range, RelatedArtifact, base64Binary, UsageContext, Timing, decimal, ParameterDefinition, dateTime, code, string, Contributor, oid, instant, ContactPoint, HumanName, Money, markdown, Ratio, Age, Reference, TriggerDefinition, Quantity, uri, url, Annotation, ContactDetail, boolean, Expression, Signature, unsignedInt, time
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
20. Meta.extension:sourceEventTimestamp
SliceNamesourceEventTimestamp
Definition

Date and time of the source event that triggers either the creation or updating of this FHIR resource

Control0..1
TypeExtension(SourceEventTimestamp) (Extension Type: dateTime)
InvariantsDefined on this element
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())
21. Meta.extension:insight
SliceNameinsight
Definition

References element level insight results pertaining to the data in this resource instance.

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.

TypeExtension(Insight) (Complex Extension)
InvariantsDefined on this element
ele-1: (: )
ext-1: (: )
22. Meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see CommonTags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
23. Meta.tag:SourceClassificationTag
SliceNameSourceClassificationTag
Definition

Identifies the origin of this FHIR resource, from either a source system of record or derived from a process

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..1*
BindingFor example codes, see CommonTags

Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. Meta.tag:SourceClassificationTag.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control10..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Pattern Valuehttp://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. Meta.tag:SourceClassificationTag.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
BindingThe codes SHALL be taken from Source Classification Value SetFor codes, see (unbound)
Typecode
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
1. Meta
Definition

The metadata about a resource. This is content in the resource that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Control0..* This element is affected by the following invariants: ele-1
2. Meta.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
3. Meta.extension
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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Meta.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. Meta.extension:ingestionBatchId
SliceNameingestionBatchId
Definition

The ID generated by an ingestion service. This represents a producer-submitted message collection

Control0..1
TypeExtension(IngestionBatchId) (Extension Type: string)
InvariantsDefined on this element
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())
5. Meta.extension:tenantId
SliceNametenantId
Definition

The ID for either the client or tenant that holds the contract with the data receiver, as recorded by the data receiver. This ID must be unique to data sent on behalf of that client or tenant within the data receiver systems. The receiver systems should associate this ID to the messages that originate from this client or tenant. This supports traceability, data protection, and data isolation, when appropriate.

Control0..1
TypeExtension(TenantId) (Extension Type: string)
InvariantsDefined on this element
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())
6. Meta.extension:processClientId
SliceNameprocessClientId
Definition

The ID of the client as recorded in the data producer or data integrator source system(s)

Control0..1
TypeExtension(ProcessClientId) (Extension Type: string)
InvariantsDefined on this element
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())
7. Meta.extension:processOrganization
SliceNameprocessOrganization
Definition

The organizing entity that owns the process that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, the process-organization value should reflect the organaization reponsible for the service.

Control0..1
TypeExtension(ProcessOrganization) (Extension Type: string)
InvariantsDefined on this element
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())
8. Meta.extension:processName
SliceNameprocessName
Definition

The name of the process or service that has produced the data held in the FHIR resource or element. Example: If an analytic service has been the producer, use the process-name as the name of that analytic service.

Control0..1
TypeExtension(ProcessName) (Extension Type: string)
InvariantsDefined on this element
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())
9. Meta.extension:processVersion
SliceNameprocessVersion
Definition

The version of either the process or the service that has produced the data held in the FHIR resource or element

Control0..1
TypeExtension(ProcessVersion) (Extension Type: string)
InvariantsDefined on this element
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())
10. Meta.extension:processType
SliceNameprocessType
Definition

The classification type of the process that has produced the data held in either the FHIR resource or element

Control0..1
TypeExtension(ProcessType) (Extension Type: string)
InvariantsDefined on this element
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())
11. Meta.extension:processRecordId
SliceNameprocessRecordId
Definition

The record ID that the data producer or data integrator uses internally to identify this data

Control0..*
TypeExtension(ProcessRecordId) (Extension Type: Identifier)
InvariantsDefined on this element
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())
12. Meta.extension:processTimestamp
SliceNameprocessTimestamp
Definition

The timestamp when the data was generated within the FHIR resource or element

Control0..1
TypeExtension(ProcessTimestamp) (Extension Type: dateTime)
InvariantsDefined on this element
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())
13. Meta.extension:sourceRecordId
SliceNamesourceRecordId
Definition

The ID for a record that the data producer or data integrator extracted knowledge from to produce the data within the FHIR resource or element

Control0..*
TypeExtension(SourceRecordId) (Extension Type: string)
InvariantsDefined on this element
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())
14. Meta.extension:sourceFileId
SliceNamesourceFileId
Definition

The ID for a file from which the data producer or data integrator extracted knowledge, to produce the data within this FHIR resource or element

Control0..*
TypeExtension(SourceFileId) (Extension Type: string)
InvariantsDefined on this element
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())
15. Meta.extension:sourceRecordType
SliceNamesourceRecordType
Definition

Either the data model type or schema type that generates this FHIR resource

Control0..1
TypeExtension(SourceRecordType) (Extension Type: CodeableConcept)
InvariantsDefined on this element
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())
16. Meta.extension:sourceDataModelVersion
SliceNamesourceDataModelVersion
Definition

Version of the source system's data model, used by either the data producer or the data integrator

Control0..1
TypeExtension(SourceDataModelVersion) (Extension Type: string)
InvariantsDefined on this element
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())
17. Meta.extension:sourceEventTrigger
SliceNamesourceEventTrigger
Definition

The event that is the catalyst for creating or updating this FHIR resource

Control0..1
TypeExtension(SourceEventTrigger) (Extension Type: CodeableConcept)
InvariantsDefined on this element
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())
18. Meta.extension:sourceEventTrigger.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
19. Meta.extension:sourceEventTrigger.extension
Definition

An Extension

Control0..0
TypeExtension
InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Meta.extension.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
20. Meta.extension:sourceEventTrigger.url
Definition

Source of the definition for the extension code - a logical name or a URL.

Control1..1
Typeuri
XML RepresentationIn the XML format, this property is represented as an attribute.
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.

Fixed Valuehttp://linuxforhealth.org/fhir/cdm/StructureDefinition/source-event-trigger
21. Meta.extension:sourceEventTrigger.value[x]
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Meta.extension.value[x]. The slices are unordered and Closed, and can be differentiated using the following discriminators:
  • type @ $this
22. Meta.extension:sourceEventTrigger.value[x]:valueCodeableConcept
SliceNamevalueCodeableConcept
Definition

Value of extension - must be one of a constrained set of the data types (see Extensibility for a list).

Control0..1
BindingFor example codes, see hl7VS-eventTypeCode
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. Meta.extension:sourceEventTimestamp
SliceNamesourceEventTimestamp
Definition

Date and time of the source event that triggers either the creation or updating of this FHIR resource

Control0..1
TypeExtension(SourceEventTimestamp) (Extension Type: dateTime)
InvariantsDefined on this element
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())
24. Meta.extension:insight
SliceNameinsight
Definition

References element level insight results pertaining to the data in this resource instance.

Control0..*
TypeExtension(Insight) (Complex Extension)
InvariantsDefined on this element
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())
25. Meta.versionId
Definition

The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

Control0..1
Typeid
Comments

The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. Meta.lastUpdated
Definition

When the resource last changed - e.g. when the version changed.

Control0..1
Typeinstant
Comments

This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. Meta.source
Definition

A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

Control0..1
Typeuri
Comments

In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. Meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

Control0..*
Typecanonical(StructureDefinition))
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. Meta.security
Definition

Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

Control0..*
BindingThe codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable Security Labels from the Healthcare Privacy and Security Classification System
TypeCoding
Comments

The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
30. Meta.tag
Definition

Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

Control0..*
BindingFor example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on Meta.tag. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ system
31. Meta.tag:SourceClassificationTag
SliceNameSourceClassificationTag
Definition

Identifies the origin of this FHIR resource, from either a source system of record or derived from a process

Control0..1
BindingFor example codes, see CommonTags Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones"
TypeCoding
Comments

The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
32. Meta.tag:SourceClassificationTag.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
33. Meta.tag:SourceClassificationTag.extension
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.

Control0..*
TypeExtension
Alternate Namesextensionsuser content
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.

InvariantsDefined on this element
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())
SlicingThis element introduces a set of slices on Meta.tag.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
34. Meta.tag:SourceClassificationTag.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

Pattern Valuehttp://linuxforhealth.org/fhir/cdm/CodeSystem/process-meta-source-classification
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
35. Meta.tag:SourceClassificationTag.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
36. Meta.tag:SourceClassificationTag.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
BindingThe codes SHALL be taken from Source Classification Value Set
Typecode
Requirements

Need to refer to a particular code in the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. Meta.tag:SourceClassificationTag.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. Meta.tag:SourceClassificationTag.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))