Diagnostic Data Services

DDS-Report-Specimen-1-0

DDS-Report-Specimen-1-0

Specimen
Definition

A sample to be used for analysis.

Control0..*
TypeSpecimen
Comments
Specimen.identifier
Definition

Identifier for specimen.

Control0..1
TypeIdentifier
Comments
Specimen.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use
TypeCode
Is ModifierTrue
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.

Exampleofficial
Specimen.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingA 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
TypeCodeableConcept
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.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.identifier.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

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.

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.

Specimen.identifier.type.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Specimen.identifier.type.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

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).

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.

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.

Control0..1
TypeString
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

Establishes the namespace in which set of possible id values is unique.

Control1..1
TypeUri
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://mmp.nhs.uk/id/specimen-id
Specimen.identifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control1..1
TypeString
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

ExampleB603CEDE-8C3F-4909-9CB1-D47C0FDE9F8A
Specimen.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Comments
Specimen.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

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.

Control0..1 ?
TypeDateTime
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.

Control0..1
TypeOrganization
Comments

The reference may be just a text description of the assigner.

Specimen.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.

Control1..1 ?
TypeString
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.

ExampleOrganisation/78D64BB3-B5B2-450B-AEB7-D9035EBC711D
Specimen.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
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.

ExampleMGP Medical Centre
Specimen.status
Definition

The availability of the specimen.

Control0..1
BindingCodes providing the status/availability of a specimen.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/specimen-status
TypeCode
Is ModifierTrue
Comments
Specimen.type
Definition

The kind of material that forms the specimen.

Control0..1
BindingThe type of the specimen.
For example codes, see http://snomed.info/sct; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.

Specimen.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
Specimen.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.

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.

Example20150731
Specimen.type.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Example119297000
Specimen.type.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

Comments
ExampleBlood 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).

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.

Specimen.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.

Control0..1
TypeString
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.

Max Length70
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.

Control0..*
TypeSpecimen
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.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.

Control1..1 ?
TypeString
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.parent.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
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

Where the specimen came from. This may be from the patient(s) or from the environment or a device.

Control1..1
TypeChoice of:
Requirements

Must know the subject context.

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.

Control0..1
TypeIdentifier
Comments
Specimen.accessionIdentifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use
TypeCode
Is ModifierTrue
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.

Control0..1
BindingA 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
TypeCodeableConcept
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.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.accessionIdentifier.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

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.

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.

Specimen.accessionIdentifier.type.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Specimen.accessionIdentifier.type.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

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).

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.

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.

Control0..1
TypeString
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

Establishes the namespace in which set of possible id values is unique.

Control1..1
TypeUri
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://www.sampleth.nhs.uk/pathology/BloodSciences/labno
Specimen.accessionIdentifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control1..1
TypeString
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

ExampleHAEM8667800001
Specimen.accessionIdentifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Comments
Specimen.accessionIdentifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

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.

Control0..1 ?
TypeDateTime
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.

Control0..1
TypeOrganization
Comments

The reference may be just a text description of the assigner.

Specimen.accessionIdentifier.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.

Control1..1 ?
TypeString
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.

ExampleOrganization/223F5C66-66BF-4CEA-A5D7-25AB9348B448
Specimen.accessionIdentifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
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.

Control0..1
TypeDateTime
Comments
Specimen.collection
Definition

Details concerning the specimen collection.

Control0..1
TypeBackboneElement
Comments
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.

Control0..*
TypeExtension
Is ModifierTrue
Aliasesextensions, 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

Person who collected the specimen.

Control0..1
TypePractitioner
Comments
Specimen.collection.collector.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.

Control1..1 ?
TypeString
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.

ExamplePractitioner/4BFCA0EF-85D0-4C5E-B662-D4910BB83D82
Specimen.collection.collector.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
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.

ExampleDr. Jones
Specimen.collection.comment
Definition

To communicate any details or issues encountered during the specimen collection procedure.

Control0..*
TypeString
Comments
Specimen.collection.collected[x]
Definition

Time when specimen was collected from subject - the physiologically relevant time.

Control0..1
TypeChoice of:
Comments
Specimen.collection.quantity
Definition

The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample.

Control0..1
TypeQuantity
Comments
Specimen.collection.quantity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1
TypeDecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Example6
Specimen.collection.quantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingHow the Quantity should be understood and represented.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator
TypeCode
Is ModifierTrue
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

A human-readable form of the unit.

Control1..1
TypeString
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments
Examplemillilitre
Specimen.collection.quantity.system
Definition

The identification of the system that provides the coded form of the unit.

Control1..1 ?
TypeUri
Requirements

Need to know the system that defines the coded form of the unit.

Comments
Examplehttp://unitsofmeasure.org
Specimen.collection.quantity.code
Definition

A computer processable form of the unit in some unit representation system.

Control1..1
TypeCode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

ExamplemL
Specimen.collection.method
Definition

A coded value specifying the technique that is used to perform the procedure.

Control0..1
BindingThe technique that is used to perform the procedure
For example codes, see http://snomed.info/sct; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments
Specimen.collection.method.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.collection.method.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://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.

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.

Specimen.collection.method.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Example32564009
Specimen.collection.method.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

Comments
Examplearterial 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).

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.

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.

Control0..1
TypeString
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.

Control0..1
BindingCodes 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
TypeCodeableConcept
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.

Specimen.collection.bodySite.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.collection.bodySite.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://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.

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.

Specimen.collection.bodySite.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Example308046002
Specimen.collection.bodySite.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

Comments
ExampleStructure 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).

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.

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.

Control0..1
TypeString
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.

Control0..*
TypeBackboneElement
Comments
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.

Control0..*
TypeExtension
Is ModifierTrue
Aliasesextensions, 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

Textual description of procedure.

Control0..1
TypeString
Comments
ExampleTreated with anticoagulants.
Specimen.treatment.procedure
Definition

A coded value specifying the procedure used to process the specimen.

Control0..1
BindingType 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
TypeCodeableConcept
Comments
Specimen.treatment.procedure.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.treatment.procedure.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

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.

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.

Specimen.treatment.procedure.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Specimen.treatment.procedure.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

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).

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.

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.

Control0..1
TypeString
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.

Control0..*
TypeSubstance
Comments
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.

Control1..1 ?
TypeString
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.

Control0..1
TypeString
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.

Control0..*
TypeBackboneElement
Comments
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.

Control0..*
TypeExtension
Is ModifierTrue
Aliasesextensions, 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

Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances.

Control0..1
TypeIdentifier
Comments
Specimen.container.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/identifier-use
TypeCode
Is ModifierTrue
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.

Control0..1
BindingA 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
TypeCodeableConcept
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.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.container.identifier.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

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.

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.

Specimen.container.identifier.type.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Specimen.container.identifier.type.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

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).

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.

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.

Control0..1
TypeString
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

Establishes the namespace in which set of possible id values is unique.

Control1..1
TypeUri
Requirements

There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers.

Comments
Examplehttp://mmp.nhs.uk/id/container-id
Specimen.container.identifier.value
Definition

The portion of the identifier typically displayed to the user and which is unique within the context of the system.

Control1..1
TypeString
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986.

Example08FC96C4-EB3A-46D3-93C5-4B23792DCC1C
Specimen.container.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
Comments
Specimen.container.identifier.period.start
Definition

The start of the period. The boundary is inclusive.

Control1..1 ?
TypeDateTime
Comments

If the low element is missing, the meaning is that the low boundary is not known.

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.

Control0..1 ?
TypeDateTime
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

Organization that issued/manages the identifier.

Control0..1
TypeOrganization
Comments

The reference may be just a text description of the assigner.

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.

Control1..1 ?
TypeString
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.

ExampleOrganization/78D64BB3-B5B2-450B-AEB7-D9035EBC711D
Specimen.container.identifier.assigner.display
Definition

Plain text narrative that identifies the resource in addition to the resource reference.

Control0..1
TypeString
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.

ExampleMGP Medical Centre
Specimen.container.description
Definition

Textual description of the container.

Control0..1
TypeString
Comments
Specimen.container.type
Definition

The type of container associated with the specimen (e.g. slide, aliquot, etc.).

Control0..1
BindingType of specimen container
For example codes, see http://snomed.info/sct; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments
Specimen.container.type.coding
Definition

A reference to a code defined by a terminology system.

Control0..1
TypeCoding
Requirements

Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labelled as UserSelected = true.

Specimen.container.type.coding.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 de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valuehttp://snomed.info/sct
Specimen.container.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.

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.

Example20150731
Specimen.container.type.coding.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).

Control1..1
TypeCode
Requirements

Need to refer to a particular code in the system.

Comments
Example434746001
Specimen.container.type.coding.display
Definition

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

Control1..1
TypeString
Requirements

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

Comments
ExampleSpecimen 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).

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.

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.

Control0..1
TypeString
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
Definition

The capacity (volume or other measure) the container may contain.

Control0..1
TypeQuantity
Comments
Specimen.container.capacity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1
TypeDecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Example10
Specimen.container.capacity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingHow the Quantity should be understood and represented.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator
TypeCode
Is ModifierTrue
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

A human-readable form of the unit.

Control1..1
TypeString
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments
Examplemillilitre
Specimen.container.capacity.system
Definition

The identification of the system that provides the coded form of the unit.

Control1..1 ?
TypeUri
Requirements

Need to know the system that defines the coded form of the unit.

Comments
Examplehttp://unitsofmeasure.org
Specimen.container.capacity.code
Definition

A computer processable form of the unit in some unit representation system.

Control1..1
TypeCode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

ExamplemL
Specimen.container.specimenQuantity
Definition

The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type.

Control0..1
TypeQuantity
Comments
Specimen.container.specimenQuantity.value
Definition

The value of the measured amount. The value includes an implicit precision in the presentation of the value.

Control1..1
TypeDecimal
Requirements

Precision is handled implicitly in almost all cases of measurement.

Comments

The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

Example6
Specimen.container.specimenQuantity.comparator
Definition

How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

Control0..1
BindingHow the Quantity should be understood and represented.
The codes SHALL be taken from http://hl7.org/fhir/ValueSet/quantity-comparator
TypeCode
Is ModifierTrue
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

A human-readable form of the unit.

Control1..1
TypeString
Requirements

There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

Comments
Examplemillilitre
Specimen.container.specimenQuantity.system
Definition

The identification of the system that provides the coded form of the unit.

Control1..1 ?
TypeUri
Requirements

Need to know the system that defines the coded form of the unit.

Comments
Examplehttp://unitsofmeasure.org
Specimen.container.specimenQuantity.code
Definition

A computer processable form of the unit in some unit representation system.

Control1..1
TypeCode
Requirements

Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

Comments

The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

ExamplemL
Specimen.container.additive[x]
Definition

Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA.

Control0..1
BindingSubstance added to specimen container
For example codes, see http://hl7.org/fhir/ValueSet/v2-0371; other codes may be used where these codes are not suitable
TypeSubstance
Comments