DDS-Report-Specimen-1
Specimen | |
Definition | |
Control | 0..* |
Type | Specimen |
Comments | |
Specimen.id | |
Definition |
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. |
Control | 0..1 ? |
Type | Id |
Comments |
The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
Specimen.meta | |
Definition |
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 ? |
Type | Meta |
Comments | |
Specimen.implicitRules | |
Definition |
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 ? |
Type | Uri |
Is Modifier | True |
Comments |
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Specimen.language | |
Definition |
The base language in which the resource is written. |
Control | 0..1 ? |
Binding |
A human language. The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | Code |
Comments |
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Specimen.text | |
Definition |
A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 ? |
Type | Narrative |
Aliases | narrative, html, xhtml, display |
Comments |
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Specimen.contained | |
Definition | |
Control | 0..* |
Type | Resource |
Comments | |
Specimen.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, 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. |
Specimen.identifier | |
Definition |
Identifier for specimen. |
Control | 0..1 |
Comments | |
Specimen.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.identifier.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.identifier.use | |
Definition | |
Control | 0..* |
Comments | |
Example | official |
Specimen.identifier.type | |
Definition |
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 ? |
Binding |
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements |
Allows users to make use of identifiers when the identifier system is not known. |
Comments |
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Specimen.identifier.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.identifier.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.identifier.type.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.identifier.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.identifier.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.identifier.type.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Specimen.identifier.type.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.identifier.type.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Specimen.identifier.type.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Specimen.identifier.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.identifier.type.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.identifier.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://mmp.nhs.uk/id/specimen-id |
Specimen.identifier.value | |
Definition | |
Control | 1..* |
Comments | |
Example | b603cede-8c3f-4909-9cb1-d47c0fde9f8a |
Specimen.identifier.period | |
Definition |
Time period during which identifier is/was valid for use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Specimen.identifier.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.identifier.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.identifier.period.start | |
Definition | |
Control | 1..* |
Comments | |
Specimen.identifier.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Specimen.identifier.assigner | |
Definition |
Organization that issued/manages the identifier. |
Control | 0..1 ? |
Type | Organization |
Comments |
The reference may be just a text description of the assigner. |
Specimen.identifier.assigner.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.identifier.assigner.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.identifier.assigner.reference | |
Definition | |
Control | 1..* |
Comments | |
Example | Organisation/78d64bb3-b5b2-450b-aeb7-d9035ebc711d |
Specimen.identifier.assigner.display | |
Definition | |
Control | 0..* |
Comments | |
Example | MGP Medical Centre |
Specimen.status | |
Definition |
The availability of the specimen. |
Control | 0..1 ? |
Binding |
Codes providing the status/availability of a specimen. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/specimen-status |
Type | Code |
Is Modifier | True |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Specimen.type | |
Definition | |
Control | 0..* |
Binding |
For example codes, see http://snomed.info/sct ; other codes may be used where these codes are not suitable |
Comments | |
Specimen.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.type.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.type.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | http://snomed.info/sct |
Specimen.type.coding.version | |
Definition | |
Control | 0..* |
Comments | |
Example | 20150731 |
Specimen.type.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Example | 119297000 |
Specimen.type.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Example | Blood specimen |
Specimen.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.type.text | |
Definition | |
Control | 0..* |
Comments | |
Max Length | 70 |
Specimen.parent | |
Definition |
Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen. |
Control | 0..* ? |
Type | Specimen |
Comments |
The parent specimen could be the source from which the??current specimen is derived by??some processing step??(e.g. an??aliquot or??isolate??or extracted nucleic acids??from clinical??samples)??or??one of many specimens that??were combined??to create a pooled sample. |
Specimen.parent.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.parent.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.parent.reference | |
Definition | |
Control | 1..* |
Comments | |
Specimen.parent.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Specimen.subject | |
Definition | |
Control | 0..* |
Type | Choice of: |
Comments | |
Specimen.accessionIdentifier | |
Definition |
The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
Control | 0..1 ? |
Type | Identifier |
Comments | |
Specimen.accessionIdentifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.accessionIdentifier.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.accessionIdentifier.use | |
Definition |
The purpose of this identifier. |
Control | 0..1 ? |
Binding |
Identifies the purpose for this identifier, if known . The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Specimen.accessionIdentifier.type | |
Definition |
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 ? |
Binding |
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements |
Allows users to make use of identifiers when the identifier system is not known. |
Comments |
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Specimen.accessionIdentifier.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.accessionIdentifier.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.accessionIdentifier.type.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.accessionIdentifier.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.accessionIdentifier.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.accessionIdentifier.type.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Specimen.accessionIdentifier.type.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.accessionIdentifier.type.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Specimen.accessionIdentifier.type.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Specimen.accessionIdentifier.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.accessionIdentifier.type.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.accessionIdentifier.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://www.sampleth.nhs.uk/pathology/BloodSciences/labno |
Specimen.accessionIdentifier.value | |
Definition | |
Control | 1..* |
Comments | |
Example | HAEM8667800001 |
Specimen.accessionIdentifier.period | |
Definition |
Time period during which identifier is/was valid for use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Specimen.accessionIdentifier.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.accessionIdentifier.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.accessionIdentifier.period.start | |
Definition | |
Control | 1..* |
Comments | |
Specimen.accessionIdentifier.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Specimen.accessionIdentifier.assigner | |
Definition |
Organization that issued/manages the identifier. |
Control | 0..1 ? |
Type | Organization |
Comments |
The reference may be just a text description of the assigner. |
Specimen.accessionIdentifier.assigner.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.accessionIdentifier.assigner.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.accessionIdentifier.assigner.reference | |
Definition | |
Control | 1..* |
Comments | |
Example | Organization/223f5c66-66bf-4cea-a5d7-25ab9348b448 |
Specimen.accessionIdentifier.assigner.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Specimen.receivedTime | |
Definition |
Time when specimen was received for processing or testing. |
Control | 0..1 ? |
Type | DateTime |
Comments | |
Specimen.collection | |
Definition |
Details concerning the specimen collection. |
Control | 0..1 ? |
Type | BackboneElement |
Comments | |
Specimen.collection.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Specimen.collection.collector | |
Definition | |
Control | 0..* |
Type | https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Practitioner-1 |
Comments | |
Specimen.collection.collector.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.collector.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.collector.reference | |
Definition | |
Control | 1..* |
Comments | |
Example | Practitioner/4bfca0ef-85d0-4c5e-b662-d4910bb83d82 |
Specimen.collection.collector.display | |
Definition | |
Control | 0..* |
Comments | |
Example | Dr. Jones |
Specimen.collection.comment | |
Definition |
To communicate any details or issues encountered during the specimen collection procedure. |
Control | 0..* ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Specimen.collection.collected[x] | |
Definition |
Time when specimen was collected from subject - the physiologically relevant time. |
Control | 0..1 ? |
Type | Choice of: |
Comments | |
Specimen.collection.quantity(SimpleQuantity) | |
Definition |
The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
Control | 0..1 ? |
Type | Quantity |
Comments |
The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Specimen.collection.quantity.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.quantity.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.quantity.value | |
Definition | |
Control | 1..* |
Comments | |
Example | 6 |
Specimen.collection.quantity.comparator | |
Definition |
Not allowed to be used in this context |
Control | 0..0 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Specimen.collection.quantity.unit | |
Definition | |
Control | 1..* |
Comments | |
Example | millilitre |
Specimen.collection.quantity.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://unitsofmeasure.org |
Specimen.collection.quantity.code | |
Definition | |
Control | 1..* |
Comments | |
Example | mL |
Specimen.collection.method | |
Definition | |
Control | 0..* |
Binding |
For example codes, see http://snomed.info/sct ; other codes may be used where these codes are not suitable |
Comments | |
Specimen.collection.method.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.method.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.method.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.collection.method.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.method.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.method.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | http://snomed.info/sct |
Specimen.collection.method.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.collection.method.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Example | 32564009 |
Specimen.collection.method.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Example | arterial specimen collection for laboratory test |
Specimen.collection.method.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.collection.method.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.collection.bodySite | |
Definition |
Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens. |
Control | 0..1 ? |
Binding |
Codes describing anatomical locations. May include laterality. For example codes, see http://hl7.org/fhir/ValueSet/body-site ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension body-site-instance. |
Specimen.collection.bodySite.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.bodySite.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.bodySite.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.collection.bodySite.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.collection.bodySite.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.collection.bodySite.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | http://hl7.org/fhir/ValueSet/body-site |
Specimen.collection.bodySite.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.collection.bodySite.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Example | 308046002 |
Specimen.collection.bodySite.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Example | Structure of superficial forearm vein |
Specimen.collection.bodySite.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.collection.bodySite.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.treatment | |
Definition |
Details concerning treatment and processing steps for the specimen. |
Control | 0..* ? |
Type | BackboneElement |
Comments | |
Specimen.treatment.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.treatment.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.treatment.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Specimen.treatment.description | |
Definition | |
Control | 0..* |
Comments | |
Example | Treated with anticoagulants. |
Specimen.treatment.procedure | |
Definition |
A coded value specifying the procedure used to process the specimen. |
Control | 0..1 ? |
Binding |
Type indicating the technique used to process the specimen For example codes, see http://hl7.org/fhir/ValueSet/specimen-treatment-procedure ; other codes may be used where these codes are not suitable |
Type | CodeableConcept |
Comments |
Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination. |
Specimen.treatment.procedure.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.treatment.procedure.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.treatment.procedure.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.treatment.procedure.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.treatment.procedure.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.treatment.procedure.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Specimen.treatment.procedure.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.treatment.procedure.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Specimen.treatment.procedure.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Specimen.treatment.procedure.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.treatment.procedure.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.treatment.additive | |
Definition |
Material used in the processing step. |
Control | 0..* ? |
Type | Substance |
Comments | |
Specimen.treatment.additive.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.treatment.additive.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.treatment.additive.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Specimen.treatment.additive.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Specimen.container | |
Definition |
The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
Control | 0..* ? |
Type | BackboneElement |
Comments | |
Specimen.container.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.modifierExtension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* ? |
Type | Extension |
Is Modifier | True |
Aliases | extensions, user content, modifiers |
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. |
Specimen.container.identifier | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.container.identifier.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.identifier.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.identifier.use | |
Definition |
The purpose of this identifier. |
Control | 0..1 ? |
Binding |
Identifies the purpose for this identifier, if known . The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use |
Type | Code |
Is Modifier | True |
Requirements |
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments |
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Specimen.container.identifier.type | |
Definition |
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose. |
Control | 0..1 ? |
Binding |
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. The codes SHALL be taken from the following if appropriate, otherwise an alternate coding may be included instead. http://hl7.org/fhir/ValueSet/identifier-type |
Type | CodeableConcept |
Requirements |
Allows users to make use of identifiers when the identifier system is not known. |
Comments |
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type. |
Specimen.container.identifier.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.identifier.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.identifier.type.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.container.identifier.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.identifier.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.identifier.type.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Specimen.container.identifier.type.coding.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. |
Control | 0..1 ? |
Type | String |
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. |
Specimen.container.identifier.type.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Specimen.container.identifier.type.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Specimen.container.identifier.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.container.identifier.type.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.container.identifier.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://mmp.nhs.uk/id/container-id |
Specimen.container.identifier.value | |
Definition | |
Control | 1..* |
Comments | |
Example | 08fc96c4-eb3a-46d3-93c5-4b23792dcc1c |
Specimen.container.identifier.period | |
Definition |
Time period during which identifier is/was valid for use. |
Control | 0..1 ? |
Type | Period |
Comments |
This is not a duration - that's a measure of time (a separate type), but a duration that occurs at a fixed value of time. A Period specifies a range of time; the context of use will specify whether the entire range applies (e.g. "the patient was an inpatient of the hospital for this time range") or one value from the range applies (e.g. "give to the patient between these two times"). If duration is required, specify the type as Interval|Duration. |
Specimen.container.identifier.period.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.identifier.period.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.identifier.period.start | |
Definition | |
Control | 1..* |
Comments | |
Specimen.container.identifier.period.end | |
Definition |
The end of the period. If the end of the period is missing, it means that the period is ongoing. The start may be in the past, and the end date in the future, which means that period is expected/planned to end at that time. |
Control | 0..1 ? |
Type | DateTime |
Comments |
The high value includes any matching date/time. i.e. 2012-02-03T10:00:00 is in a period that has a end value of 2012-02-03. |
Specimen.container.identifier.assigner | |
Definition | |
Control | 0..* |
Type | https://fhir.hl7.org.uk/StructureDefinition/CareConnect-Organization-1 |
Comments | |
Specimen.container.identifier.assigner.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.identifier.assigner.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.identifier.assigner.reference | |
Definition |
A reference to a location at which the other resource is found. The reference may be a relative reference, in which case it is relative to the service base URL, or an absolute URL that resolves to the location where the resource is found. The reference may be version specific or not. If the reference is not to a FHIR RESTful server, then it should be assumed to be version specific. Internal fragment references (start with '#') refer to contained resources. |
Control | 0..1 ? |
Type | String |
Comments |
Using absolute URLs provides a stable scalable approach suitable for a cloud/web context, while using relative/logical references provides a flexible approach suitable for use when trading across closed eco-system boundaries. Absolute URLs do not need to point to a FHIR RESTful server, though this is the preferred approach. If the URL conforms to the structure "/[type]/[id]" then it should be assumed that the reference is to a FHIR RESTful server. |
Specimen.container.identifier.assigner.display | |
Definition |
Plain text narrative that identifies the resource in addition to the resource reference. |
Control | 0..1 ? |
Type | String |
Comments |
This is generally not the same as the Resource.text of the referenced resource. The purpose is to identify what's being referenced, not to fully describe it. |
Specimen.container.description | |
Definition |
Textual description of the container. |
Control | 0..1 ? |
Type | String |
Comments |
Note that FHIR strings may not exceed 1MB in size |
Specimen.container.type | |
Definition | |
Control | 0..* |
Binding |
For example codes, see http://snomed.info/sct ; other codes may be used where these codes are not suitable |
Comments | |
Specimen.container.type.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.type.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.type.coding | |
Definition | |
Control | 0..1 |
Comments | |
Specimen.container.type.coding.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.type.coding.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.type.coding.system | |
Definition | |
Control | 1..* |
Comments | |
Fixed Value | http://snomed.info/sct |
Specimen.container.type.coding.version | |
Definition | |
Control | 0..* |
Comments | |
Example | 20150731 |
Specimen.container.type.coding.code | |
Definition | |
Control | 1..* |
Comments | |
Example | 434746001 |
Specimen.container.type.coding.display | |
Definition | |
Control | 1..* |
Comments | |
Example | Specimen vial |
Specimen.container.type.coding.userSelected | |
Definition |
Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 ? |
Type | Boolean |
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. |
Specimen.container.type.text | |
Definition |
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user. |
Control | 0..1 ? |
Type | String |
Requirements |
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments |
Very often the text is the same as a displayName of one of the codings. |
Specimen.container.capacity(SimpleQuantity) | |
Definition |
The capacity (volume or other measure) the container may contain. |
Control | 0..1 ? |
Type | Quantity |
Comments |
The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Specimen.container.capacity.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.capacity.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.capacity.value | |
Definition | |
Control | 1..* |
Comments | |
Example | 10 |
Specimen.container.capacity.comparator | |
Definition |
Not allowed to be used in this context |
Control | 0..0 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Specimen.container.capacity.unit | |
Definition | |
Control | 1..* |
Comments | |
Example | millilitre |
Specimen.container.capacity.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://unitsofmeasure.org |
Specimen.container.capacity.code | |
Definition | |
Control | 1..* |
Comments | |
Example | mL |
Specimen.container.specimenQuantity(SimpleQuantity) | |
Definition |
The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
Control | 0..1 ? |
Type | Quantity |
Comments |
The context of use may frequently define what kind of quantity this is and therefore what kind of units can be used. The context of use may also restrict the values for the comparator. |
Specimen.container.specimenQuantity.id | |
Definition |
unique id for the element within a resource (for internal references). |
Control | 0..1 ? |
Type | Id |
Comments |
RFC 4122 |
Specimen.container.specimenQuantity.extension | |
Definition |
May be used to represent additional information that is not part of the basic definition of the element. In order 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 is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* ? |
Type | Extension |
Aliases | extensions, 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. |
Specimen.container.specimenQuantity.value | |
Definition | |
Control | 1..* |
Comments | |
Example | 6 |
Specimen.container.specimenQuantity.comparator | |
Definition |
Not allowed to be used in this context |
Control | 0..0 ? |
Binding |
How the Quantity should be understood and represented. The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator |
Type | Code |
Is Modifier | True |
Requirements |
Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology. |
Comments |
This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value. |
Specimen.container.specimenQuantity.unit | |
Definition | |
Control | 1..* |
Comments | |
Example | millilitre |
Specimen.container.specimenQuantity.system | |
Definition | |
Control | 1..* |
Comments | |
Example | http://unitsofmeasure.org |
Specimen.container.specimenQuantity.code | |
Definition | |
Control | 1..* |
Comments | |
Example | mL |
Specimen.container.additiveReference | |
Definition | |
Control | 0..* |
Type | Substance |
Comments |