Copy of 'GP Connect Data Model | FHIR STU3 Representation'

Profile: CareConnect-GPC-Specimen-1

CareConnect-GPC-Specimen-1 (Specimen)

There are no (further) constraints on this element

Element id

Specimen

Short description

Sample for analysis

Definition

A sample to be used for analysis.

Data type

Specimen

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role[classCode=SPEC]

0..1

There are no (further) constraints on this element

Element id

Specimen.id

Short description

Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

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.

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Meta

There are no (further) constraints on this element

Element id

Specimen.meta

Short description

Metadata about the resource

Definition

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

Data type

Meta

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Specimen.meta.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.meta.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

versionId

0..1

There are no (further) constraints on this element

Element id

Specimen.meta.versionId

Short description

Version specific identifier

Definition

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

Comments

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

Data type

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

lastUpdated

0..1

instant

There are no (further) constraints on this element

Element id

Specimen.meta.lastUpdated

Short description

When the resource version last changed

Definition

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

Comments

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

Data type

instant

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

source

0..1

uri

There are no (further) constraints on this element

Element id

Specimen.meta.source

Short description

Identifies where the resource comes from

Definition

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

Comments

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

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

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

profile

1..*

canonical(StructureDefinition)

There are no (further) constraints on this element

Element id

Specimen.meta.profile

Short description

Profiles this resource claims to conform to

Definition

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

Comments

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

Data type

canonical(StructureDefinition)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

security

0..*

CodingBinding

There are no (further) constraints on this element

Element id

Specimen.meta.security

Short description

Security Labels applied to this resource

Definition

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

Comments

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

Data type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

tag

0..*

Coding

There are no (further) constraints on this element

Element id

Specimen.meta.tag

Short description

Tags applied to this resource

Definition

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

Comments

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

Data type

Coding

Binding

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

CommonTags (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

implicitRules

Σ ?!

0..1

uri

There are no (further) constraints on this element

Element id

Specimen.implicitRules

Short description

A set of rules under which this content was created

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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

language

0..1

codeBinding

There are no (further) constraints on this element

Element id

Specimen.language

Short description

Language of the resource content

Definition

The base language in which the resource is written.

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

Data type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

text

0..1

Narrative

There are no (further) constraints on this element

Element id

Specimen.text

Short description

Text summary of the resource, for human interpretation

Alternate names

narrative, html, xhtml, display

Definition

A human-readable narrative that contains a summary of the resource and can 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.

Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Data type

Narrative

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

contained

0..*

Resource

There are no (further) constraints on this element

Element id

Specimen.contained

Short description

Contained, inline Resources

Alternate names

inline resources, anonymous resources, contained resources

Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Data type

Resource

Mappings

rim: Entity. Role, or Act
rim: N/A

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.modifierExtension

Short description

Extensions that cannot be ignored

Alternate names

extensions, user content

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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

1..*

Identifier

There are no (further) constraints on this element

Element id

Specimen.identifier

Short description

External Identifier

Definition

Id for specimen.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: SPM-2
rim: .id

0..1

string

There are no (further) constraints on this element

Element id

Specimen.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Specimen.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Specimen.identifier.type

Short description

Description of identifier

Definition

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

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.

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

1..1

uri

There are no (further) constraints on this element

Element id

Specimen.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

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

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

1..1

string

There are no (further) constraints on this element

Element id

Specimen.identifier.value

Short description

The value that is unique

Definition

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

Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension. Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Specimen.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

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

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference(Organization)

There are no (further) constraints on this element

Element id

Specimen.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(Organization)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

accessionIdentifier

S Σ

0..1

Identifier

Element id

Specimen.accessionIdentifier

Short description

A business level identifier for the specimen supplied by the performing organisation. eg. lab performing the test.

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: SPM-30 (v2.7+)
rim: .participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id

0..1

string

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.type

Short description

Description of identifier

Definition

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

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

uri

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

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

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

string

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Specimen.accessionIdentifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference(CareConnect-GPC-Organization-1)

Element id

Specimen.accessionIdentifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(CareConnect-GPC-Organization-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

status

S Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Specimen.status

Short description

available | unavailable | unsatisfactory | entered-in-error

Definition

The availability of the specimen.

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Data type

code

Binding

Codes providing the status/availability of a specimen.

SpecimenStatus (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.status
v2: SPM-20
rim: status

type

S Σ

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Specimen.type

Short description

Kind of material that forms the specimen

Definition

The kind of material that forms the specimen.

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.

Data type

CodeableConcept

Binding

The type of the specimen.

v2.0487 (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.what[x]
v2: SPM-4 and possibly SPM-5
rim: .code

0..1

string

There are no (further) constraints on this element

Element id

Specimen.type.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.type.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

Coding

Element id

Specimen.type.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

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 labeled as UserSelected = true.

Data type

Coding

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomedCT

0..*

CodingBinding

Element id

Specimen.type.coding:snomedCT

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

A code from the SNOMED Clinical Terminology UK

(unbound) (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

snomedCTDescriptionID

0..*

Extension

Element id

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.url

Short description

identifies the meaning of the extension

Definition

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

Comments

The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short description

Value of extension

Definition

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

system

1..1

uri

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

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

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.version

Short description

Version of the system - if relevant

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.code

Short description

Symbol in syntax defined by the system

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

string

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Specimen.type.coding:snomedCT.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

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.

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

Specimen.type.text

Short description

Plain text representation of the concept

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.

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.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

subject

Σ C

0..1

Reference(Group) | Reference(Device) | Reference(Substance) | Reference(CareConnect-GPC-Patient-1)

Element id

Specimen.subject

Short description

A reference to the Patient who the observation is about.

Definition

Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

Requirements

Must know the subject context.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

Data type

Reference(Group) | Reference(Device) | Reference(Substance) | Reference(CareConnect-GPC-Patient-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
rim: .scoper or .scoper.playsRole
w5: FiveWs.subject

receivedTime

S Σ

0..1

dateTime

There are no (further) constraints on this element

Element id

Specimen.receivedTime

Short description

The time when specimen was received for processing

Definition

Time when specimen was received for processing or testing.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.done[x]
v2: SPM-18
rim: .participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime

parent

0..*

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1)

Element id

Specimen.parent

Short description

Specimen from which this specimen originated

Definition

Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another 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.

Data type

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)

request

0..*

Reference(CareConnect-GPC-ProcedureRequest-1)

Element id

Specimen.request

Short description

Why the specimen was collected

Definition

Details concerning a service request that required a specimen to be collected.

Comments

The request may be explicit or implied such with a ServiceRequest that requires a blood draw.

Data type

Reference(CareConnect-GPC-ProcedureRequest-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.why[x]
v2: ORC? OBR-2/3?
rim: outboundRelationship[typeCode=FLFS].target

collection

0..1

BackboneElement

Element id

Specimen.collection

Short description

Details of when/how the specimen was collected.

Definition

Details concerning the specimen collection.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SPM-14
rim: .participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

fastingStatus

S C

0..*

Extension

Element id

Specimen.collection.extension:fastingStatus

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.extension:fastingStatus.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.extension:fastingStatus.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Specimen.collection.extension:fastingStatus.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.collection.extension:fastingStatus.value[x]

Short description

Value of extension

Definition

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

collector

S Σ C

0..1

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)

Element id

Specimen.collection.collector

Short description

Reference to the resource for the Practitioner that collected the specimen.

Definition

Person who collected the specimen.

Comments

Data type

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.actor
v2: PRT
rim: .participation[typeCode=PFM].role

collected[x]

S Σ

0..1

Element id

Specimen.collection.collected[x]

Short description

The date and time when the specimen was collected.

Definition

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.init
v2: SPM-17
rim: .effectiveTime

collectedDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

collectedPeriod

Period

There are no (further) constraints on this element

Data type

Period

duration

Σ C

0..1

Duration

There are no (further) constraints on this element

Element id

Specimen.collection.duration

Short description

How long it took to collect specimen

Definition

The span of time over which the collection of a specimen occurred.

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.

Data type

Duration

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
code.exists() implies ((system = %ucum) and value.exists())

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: PQ, IVL<PQ> depending on the values
w5: FiveWs.init

quantity

S C

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Specimen.collection.quantity

Short description

The quantity of specimen collected

Definition

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

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.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: SPM-12
rim: .participation[typeCode=SBJ].role[classCode=SPEC].player.quantity

method

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Specimen.collection.method

Short description

Technique used to perform collection

Definition

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

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.

Data type

CodeableConcept

Binding

The technique that is used to perform the procedure.

FHIRSpecimenCollectionMethod (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-7
rim: .methodCode

bodySite

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite

Short description

Anatomical collection site

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.

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

Data type

CodeableConcept

Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-8 and SPM-9
rim: .targetSiteCode

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

coding

0..*

Coding

Element id

Specimen.collection.bodySite.coding

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Slicing

Unordered, Open, by system(Value)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

snomedCT

0..*

CodingBinding

Element id

Specimen.collection.bodySite.coding:snomedCT

Short description

Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Data type

Coding

Binding

A code from the SNOMED Clinical Terminology UK

(unbound) (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

snomedCTDescriptionID

0..*

Extension

Element id

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Extension URL

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

url

1..1

uriFixed Value

Element id

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url

Short description

identifies the meaning of the extension

Definition

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

Comments

Data type

uri

Fixed value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

value[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short description

Value of extension

Definition

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

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

valueAddress

Address

There are no (further) constraints on this element

Data type

Address

valueAge

Age

There are no (further) constraints on this element

Data type

Age

valueAnnotation

Annotation

There are no (further) constraints on this element

Data type

Annotation

valueAttachment

Attachment

There are no (further) constraints on this element

Data type

Attachment

valueBase64Binary

base64Binary

There are no (further) constraints on this element

Data type

base64Binary

valueBoolean

boolean

There are no (further) constraints on this element

Data type

boolean

valueCanonical

canonical

There are no (further) constraints on this element

Data type

canonical

valueCode

code

There are no (further) constraints on this element

Data type

code

valueCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

valueCoding

Coding

There are no (further) constraints on this element

Data type

Coding

valueContactDetail

ContactDetail

There are no (further) constraints on this element

Data type

ContactDetail

valueContactPoint

ContactPoint

There are no (further) constraints on this element

Data type

ContactPoint

valueContributor

Contributor

There are no (further) constraints on this element

Data type

Contributor

valueCount

Count

There are no (further) constraints on this element

Data type

Count

valueDataRequirement

DataRequirement

There are no (further) constraints on this element

Data type

DataRequirement

valueDate

date

There are no (further) constraints on this element

Data type

date

valueDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

valueDecimal

decimal

There are no (further) constraints on this element

Data type

decimal

valueDistance

Distance

There are no (further) constraints on this element

Data type

Distance

valueDosage

Dosage

There are no (further) constraints on this element

Data type

Dosage

valueDuration

Duration

There are no (further) constraints on this element

Data type

Duration

valueExpression

Expression

There are no (further) constraints on this element

Data type

Expression

valueHumanName

HumanName

There are no (further) constraints on this element

Data type

HumanName

valueId

There are no (further) constraints on this element

Data type

valueIdentifier

Identifier

There are no (further) constraints on this element

Data type

Identifier

valueInstant

instant

There are no (further) constraints on this element

Data type

instant

valueInteger

integer

There are no (further) constraints on this element

Data type

integer

valueMarkdown

markdown

There are no (further) constraints on this element

Data type

markdown

valueMeta

Meta

There are no (further) constraints on this element

Data type

Meta

valueMoney

Money

There are no (further) constraints on this element

Data type

Money

valueOid

oid

There are no (further) constraints on this element

Data type

oid

valueParameterDefinition

ParameterDefinition

There are no (further) constraints on this element

Data type

ParameterDefinition

valuePeriod

Period

There are no (further) constraints on this element

Data type

Period

valuePositiveInt

positiveInt

There are no (further) constraints on this element

Data type

positiveInt

valueQuantity

Quantity

There are no (further) constraints on this element

Data type

Quantity

valueRange

Range

There are no (further) constraints on this element

Data type

Range

valueRatio

Ratio

There are no (further) constraints on this element

Data type

Ratio

valueReference

Reference

There are no (further) constraints on this element

Data type

Reference

valueRelatedArtifact

RelatedArtifact

There are no (further) constraints on this element

Data type

RelatedArtifact

valueSampledData

SampledData

There are no (further) constraints on this element

Data type

SampledData

valueSignature

Signature

There are no (further) constraints on this element

Data type

Signature

valueString

string

There are no (further) constraints on this element

Data type

string

valueTime

time

There are no (further) constraints on this element

Data type

time

valueTiming

Timing

There are no (further) constraints on this element

Data type

Timing

valueTriggerDefinition

TriggerDefinition

There are no (further) constraints on this element

Data type

TriggerDefinition

valueUnsignedInt

unsignedInt

There are no (further) constraints on this element

Data type

unsignedInt

valueUri

uri

There are no (further) constraints on this element

Data type

uri

valueUrl

url

There are no (further) constraints on this element

Data type

url

valueUsageContext

UsageContext

There are no (further) constraints on this element

Data type

UsageContext

valueUuid

uuid

There are no (further) constraints on this element

Data type

uuid

system

1..1

uri

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.system

Short description

Identity of the terminology system

Definition

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

Requirements

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

Comments

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

version

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.version

Short description

Version of the system - if relevant

Definition

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

code

1..1

code

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.code

Short description

Symbol in syntax defined by the system

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

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

code

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

display

1..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.display

Short description

Representation defined by the system

Definition

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

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

userSelected

0..1

boolean

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.coding:snomedCT.userSelected

Short description

If this coding was chosen directly by the user

Definition

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

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

Data type

boolean

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

text

0..1

string

There are no (further) constraints on this element

Element id

Specimen.collection.bodySite.text

Short description

Plain text representation of the concept

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.

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

fastingStatus[x]

0..1

Binding

There are no (further) constraints on this element

Element id

Specimen.collection.fastingStatus[x]

Short description

Whether or how long patient abstained from food and/or drink

Definition

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

Requirements

Many diagnostic tests require fasting to facilitate accurate interpretation.

Comments

Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation such asObservation.component code` = LOINC 49541-6 (Fasting status - Reported).

Binding

Codes describing the fasting status of the patient.

v2.0916 (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBR-

fastingStatusCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

fastingStatusDuration

Duration

There are no (further) constraints on this element

Data type

Duration

processing

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Specimen.processing

Short description

Processing and processing step details

Definition

Details concerning processing and processing steps for the specimen.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]

0..1

string

There are no (further) constraints on this element

Element id

Specimen.processing.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.processing.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.processing.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

description

0..1

string

There are no (further) constraints on this element

Element id

Specimen.processing.description

Short description

Textual description of procedure

Definition

Textual description of procedure.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .text

procedure

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Specimen.processing.procedure

Short description

Indicates the treatment step applied to the specimen

Definition

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

Comments

Data type

CodeableConcept

Binding

Type indicating the technique used to process the specimen.

SpecimenProcessingProcedure (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

additive

0..*

Reference(Substance)

There are no (further) constraints on this element

Element id

Specimen.processing.additive

Short description

Material used in the processing step

Definition

Material used in the processing step.

Comments

Data type

Reference(Substance)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: SPM-6
rim: .participation[typeCode=CSM].role[classCode=ADTV].code

time[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.processing.time[x]

Short description

Date and time of specimen processing

Definition

A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .effectiveTime

timeDateTime

dateTime

There are no (further) constraints on this element

Data type

dateTime

timePeriod

Period

There are no (further) constraints on this element

Data type

Period

container

0..*

BackboneElement

There are no (further) constraints on this element

Element id

Specimen.container

Short description

Direct container of specimen (tube/slide, etc.)

Definition

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Data type

BackboneElement

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .player.scopingRole[classCode=CONT].scoper

0..1

string

There are no (further) constraints on this element

Element id

Specimen.container.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.container.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

modifierExtension

Σ ?! C

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.container.modifierExtension

Short description

Extensions that cannot be ignored even if unrecognized

Alternate names

extensions, user content, modifiers

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Requirements

Comments

Data type

Extension

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

identifier

0..*

Identifier

There are no (further) constraints on this element

Element id

Specimen.container.identifier

Short description

Id for the container

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.

Data type

Identifier

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
v2: SAC-3
rim: .id

0..1

string

There are no (further) constraints on this element

Element id

Specimen.container.identifier.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.container.identifier.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

use

Σ ?!

0..1

codeBinding

There are no (further) constraints on this element

Element id

Specimen.container.identifier.use

Short description

usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Data type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

type

0..1

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Specimen.container.identifier.type

Short description

Description of identifier

Definition

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

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Data type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

system

0..1

uri

There are no (further) constraints on this element

Element id

Specimen.container.identifier.system

Short description

The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Requirements

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

Comments

Identifier.system is always case sensitive.

Data type

uri

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

value

0..1

string

There are no (further) constraints on this element

Element id

Specimen.container.identifier.value

Short description

The value that is unique

Definition

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

Comments

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples
General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

period

Σ C

0..1

Period

There are no (further) constraints on this element

Element id

Specimen.container.identifier.period

Short description

Time period when id is/was valid for use

Definition

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

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Data type

Period

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

assigner

Σ C

0..1

Reference(CareConnect-GPC-Organization-1)

Element id

Specimen.container.identifier.assigner

Short description

Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Data type

Reference(CareConnect-GPC-Organization-1)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

description

0..1

string

There are no (further) constraints on this element

Element id

Specimen.container.description

Short description

Textual description of the container

Definition

Textual description of the container.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Data type

string

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .desc

type

0..1

CodeableConcept

There are no (further) constraints on this element

Element id

Specimen.container.type

Short description

Kind of container directly associated with specimen

Definition

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

Comments

Data type

CodeableConcept

Binding

Type of specimen container.

SpecimenContainerType (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-27
rim: .code

capacity

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Specimen.container.capacity

Short description

Container volume or size

Definition

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

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.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20
rim: .quantity

specimenQuantity

0..1

SimpleQuantity

There are no (further) constraints on this element

Element id

Specimen.container.specimenQuantity

Short description

Quantity of specimen within container

Definition

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

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.

Data type

SimpleQuantity

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: SAC-23 (value) SAC-24 (units
rim: .playedRole[classCode=CONT].quantity

additive[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.container.additive[x]

Short description

Additive associated with container

Definition

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

Binding

Substance added to specimen container.

v2.0371 (example)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SAC-27
rim: .scopesRole[classCode=ADTV].player

additiveCodeableConcept

CodeableConcept

There are no (further) constraints on this element

Data type

CodeableConcept

additiveReference

Reference(Substance)

There are no (further) constraints on this element

Data type

Reference(Substance)

condition

0..*

CodeableConceptBinding

There are no (further) constraints on this element

Element id

Specimen.condition

Short description

State of the specimen

Definition

A mode or state of being that describes the nature of the specimen.

Requirements

The specimen condition can be used to assess its quality or appropriateness for a specific test.

Comments

Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.

Data type

CodeableConcept

Binding

Codes describing the state of the specimen.

v2.0493 (extensible)

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-24

note

0..1

Annotation

Element id

Specimen.note

Short description

Notes/comments relating to the specimen.

Definition

To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Data type

Annotation

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act
v2: OBX
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

0..1

string

There are no (further) constraints on this element

Element id

Specimen.note.id

Short description

Unique id for inter-element referencing

Definition

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

Data type

string

Mappings

rim: n/a

extension

0..*

Extension

There are no (further) constraints on this element

Element id

Specimen.note.extension

Short description

Additional content defined by implementations

Alternate names

extensions, user content

Definition

Comments

Data type

Extension

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

author[x]

0..1

There are no (further) constraints on this element

Element id

Specimen.note.author[x]

Short description

Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

authorReference

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)

Data type

Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1)

authorString

string

Data type

string

time

0..1

dateTime

There are no (further) constraints on this element

Element id

Specimen.note.time

Short description

When the annotation was made

Definition

Indicates when this particular annotation was made.

Data type

dateTime

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

text

1..1

markdown

There are no (further) constraints on this element

Element id

Specimen.note.text

Short description

The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Data type

markdown

Conditions

The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.text

Specimen C

Short Sample for analysis

Definition

A sample to be used for analysis.

Cardinality 0..*

Constraints

dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
contained.contained.empty()
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-6: A resource should have narrative for robust management
text.`div`.exists()
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
contained.meta.security.empty()

Mappings

rim: Entity. Role, or Act
rim: Role[classCode=SPEC]

Specimen.id Σ

Short Logical id of this artifact

Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Cardinality 0..1

Type

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.meta Σ

Short Metadata about the resource

Definition

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

Cardinality 0..1

Type

Meta

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Specimen.meta.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.meta.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.meta.versionId Σ

Short Version specific identifier

Definition

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

Cardinality 0..1

Type

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.meta.lastUpdated Σ

Short When the resource version last changed

Definition

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

Cardinality 0..1

Type

instant

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.meta.source Σ

Short Identifies where the resource comes from

Definition

Cardinality 0..1

Type

uri

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.meta.profile Σ

Short Profiles this resource claims to conform to

Definition

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

Cardinality 1..*

Type canonical(StructureDefinition)

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.meta.security Σ

Short Security Labels applied to this resource

Definition

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

Cardinality 0..*

Type

Coding

Binding

Security Labels from the Healthcare Privacy and Security Classification System.

AllSecurityLabels (extensible)

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Specimen.meta.tag Σ

Short Tags applied to this resource

Definition

Cardinality 0..*

Type

Coding

Binding

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

CommonTags (example)

Summary True

Comments

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding

Specimen.implicitRules Σ ?!

Short A set of rules under which this content was created

Definition

Cardinality 0..1

Type

uri

Modifier True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.language

Short Language of the resource content

Definition

The base language in which the resource is written.

Cardinality 0..1

Type

code

Binding

A human language.

CommonLanguages (preferred)

Binding extensions

MaxValueSet	AllLanguages

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a

Specimen.text

Short Text summary of the resource, for human interpretation

Definition

Cardinality 0..1

Type

Narrative

Alias narrative, html, xhtml, display

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A
rim: Act.text?

Specimen.contained

Short Contained, inline Resources

Definition

Cardinality 0..*

Type

Resource

Alias inline resources, anonymous resources, contained resources

Comments

Mappings

rim: Entity. Role, or Act
rim: N/A

Specimen.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.modifierExtension ?! C

Short Extensions that cannot be ignored

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Alias extensions, user content

Requirements

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.identifier Σ

Short External Identifier

Definition

Id for specimen.

Cardinality 1..*

Type

Identifier

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: SPM-2
rim: .id

Specimen.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Specimen.identifier.type Σ

Short Description of identifier

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Specimen.identifier.system Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 1..1

Type

uri

Summary True

Requirements

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

Comments

Identifier.system is always case sensitive.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Specimen.identifier.value Σ

Short The value that is unique

Definition

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

Cardinality 1..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Specimen.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

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

Cardinality 0..1

Type

Period

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Specimen.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(Organization)

Summary True

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Specimen.accessionIdentifier S Σ

Short A business level identifier for the specimen supplied by the performing organisation. eg. lab performing the test.

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.

Cardinality 0..1

Type

Identifier

Must Support True

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
w5: FiveWs.identifier
v2: SPM-30 (v2.7+)
rim: .participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id

Specimen.accessionIdentifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.accessionIdentifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.accessionIdentifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Specimen.accessionIdentifier.type Σ

Short Description of identifier

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Specimen.accessionIdentifier.system Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 0..1

Type

uri

Summary True

Requirements

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

Comments

Identifier.system is always case sensitive.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Specimen.accessionIdentifier.value Σ

Short The value that is unique

Definition

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

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Specimen.accessionIdentifier.period Σ C

Short Time period when id is/was valid for use

Definition

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

Cardinality 0..1

Type

Period

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Specimen.accessionIdentifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Summary True

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Specimen.status S Σ ?!

Short available | unavailable | unsatisfactory | entered-in-error

Definition

The availability of the specimen.

Cardinality 0..1

Type

code

Binding

Codes providing the status/availability of a specimen.

SpecimenStatus (required)

Must Support True

Modifier True

Summary True

Comments

This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.status
v2: SPM-20
rim: status

Specimen.type S Σ

Short Kind of material that forms the specimen

Definition

The kind of material that forms the specimen.

Cardinality 0..1

Type

CodeableConcept

Binding

The type of the specimen.

v2.0487 (example)

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
w5: FiveWs.what[x]
v2: SPM-4 and possibly SPM-5
rim: .code

Specimen.type.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.type.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.type.coding Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Slicing

Unordered, Open, by system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Specimen.type.coding:snomedCT Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Binding

A code from the SNOMED Clinical Terminology UK

(unbound) (extensible)

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Specimen.type.coding:snomedCT.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.type.coding:snomedCT.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Specimen.type.coding:snomedCT.system Σ

Short Identity of the terminology system

Definition

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

Cardinality 1..1

Type

uri

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Specimen.type.coding:snomedCT.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Specimen.type.coding:snomedCT.code Σ

Short Symbol in syntax defined by the system

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

Cardinality 1..1

Type

code

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Specimen.type.coding:snomedCT.display Σ

Short Representation defined by the system

Definition

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

Cardinality 1..1

Type

string

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Specimen.type.coding:snomedCT.userSelected Σ

Short If this coding was chosen directly by the user

Definition

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

Cardinality 0..1

Type

boolean

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Specimen.type.text Σ

Short Plain text representation of the concept

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.

Cardinality 0..1

Type

string

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Specimen.subject Σ C

Short A reference to the Patient who the observation is about.

Definition

Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.

Cardinality 0..1

Type Reference(Group) | Reference(Device) | Reference(Substance) | Reference(CareConnect-GPC-Patient-1)

Summary True

Requirements

Must know the subject context.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.subject[x]
rim: .scoper or .scoper.playsRole
w5: FiveWs.subject

Specimen.receivedTime S Σ

Short The time when specimen was received for processing

Definition

Time when specimen was received for processing or testing.

Cardinality 0..1

Type

dateTime

Must Support True

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.done[x]
v2: SPM-18
rim: .participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime

Specimen.parent C

Short Specimen from which this specimen originated

Definition

Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen.

Cardinality 0..*

Type Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
rim: .scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)

Specimen.request C

Short Why the specimen was collected

Definition

Details concerning a service request that required a specimen to be collected.

Cardinality 0..*

Type Reference(CareConnect-GPC-ProcedureRequest-1)

Comments

The request may be explicit or implied such with a ServiceRequest that requires a blood draw.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.why[x]
v2: ORC? OBR-2/3?
rim: outboundRelationship[typeCode=FLFS].target

Specimen.collection S

Short Details of when/how the specimen was collected.

Definition

Details concerning the specimen collection.

Cardinality 0..1

Type

BackboneElement

Must Support True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SPM-14
rim: .participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]

Specimen.collection.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.collection.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.extension:fastingStatus S C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Must Support True

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.extension:fastingStatus.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.collection.extension:fastingStatus.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.extension:fastingStatus.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1

Mappings

rim: N/A

Specimen.collection.extension:fastingStatus.value[x]

Short Value of extension

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Specimen.collection.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.collector S Σ C

Short Reference to the resource for the Practitioner that collected the specimen.

Definition

Person who collected the specimen.

Cardinality 0..1

Type Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1)

Must Support True

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
w5: FiveWs.actor
v2: PRT
rim: .participation[typeCode=PFM].role

Specimen.collection.collected[x] S Σ

Short The date and time when the specimen was collected.

Definition

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

Cardinality 0..1

Type dateTime | Period

Must Support True

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
w5: FiveWs.init
v2: SPM-17
rim: .effectiveTime

Specimen.collection.duration Σ C

Short How long it took to collect specimen

Definition

The span of time over which the collection of a specimen occurred.

Cardinality 0..1

Type

Duration

Summary True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
drt-1: There SHALL be a code if there is a value and it SHALL be an expression of time. If system is present, it SHALL be UCUM.
code.exists() implies ((system = %ucum) and value.exists())

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
rim: PQ, IVL<PQ> depending on the values
w5: FiveWs.init

Specimen.collection.quantity S C

Short The quantity of specimen collected

Definition

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

Cardinality 0..1

Type

SimpleQuantity

Must Support True

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: SPM-12
rim: .participation[typeCode=SBJ].role[classCode=SPEC].player.quantity

Specimen.collection.method

Short Technique used to perform collection

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

The technique that is used to perform the procedure.

FHIRSpecimenCollectionMethod (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-7
rim: .methodCode

Specimen.collection.bodySite S

Short Anatomical collection site

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.

Cardinality 0..1

Type

CodeableConcept

Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)

Must Support True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-8 and SPM-9
rim: .targetSiteCode

Specimen.collection.bodySite.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.collection.bodySite.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.bodySite.coding Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Slicing

Unordered, Open, by system(Value)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Specimen.collection.bodySite.coding:snomedCT Σ

Short Code defined by a terminology system

Definition

A reference to a code defined by a terminology system.

Cardinality 0..*

Type

Coding

Binding

A code from the SNOMED Clinical Terminology UK

(unbound) (extensible)

Summary True

Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE subset one of the sets of component 1-3 or 4-6
rim: CV
orim: fhir:Coding rdfs:subClassOf dt:CDCoding
v2: C*E.1-8, C*E.10-22
rim: union(., ./translation)
orim: fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding

Specimen.collection.bodySite.coding:snomedCT.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.collection.bodySite.coding:snomedCT.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url

Short identifies the meaning of the extension

Definition

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

Cardinality 1..1

Type

uri

Comments

Fixed Value

https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid

Mappings

rim: N/A

Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.value[x]

Short Value of extension

Definition

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

Cardinality 0..1

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: N/A

Specimen.collection.bodySite.coding:snomedCT.system Σ

Short Identity of the terminology system

Definition

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

Cardinality 1..1

Type

uri

Summary True

Requirements

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

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.3
rim: ./codeSystem
orim: fhir:Coding.system rdfs:subPropertyOf dt:CDCoding.codeSystem

Specimen.collection.bodySite.coding:snomedCT.version Σ

Short Version of the system - if relevant

Definition

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.7
rim: ./codeSystemVersion
orim: fhir:Coding.version rdfs:subPropertyOf dt:CDCoding.codeSystemVersion

Specimen.collection.bodySite.coding:snomedCT.code Σ

Short Symbol in syntax defined by the system

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

Cardinality 1..1

Type

code

Summary True

Requirements

Need to refer to a particular code in the system.

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.1
rim: ./code
orim: fhir:Coding.code rdfs:subPropertyOf dt:CDCoding.code

Specimen.collection.bodySite.coding:snomedCT.display Σ

Short Representation defined by the system

Definition

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

Cardinality 1..1

Type

string

Summary True

Requirements

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

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.2 - but note this is not well followed
rim: CV.displayName
orim: fhir:Coding.display rdfs:subPropertyOf dt:CDCoding.displayName

Specimen.collection.bodySite.coding:snomedCT.userSelected Σ

Short If this coding was chosen directly by the user

Definition

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

Cardinality 0..1

Type

boolean

Summary True

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

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: Sometimes implied by being first
rim: CD.codingRationale
orim: fhir:Coding.userSelected fhir:mapsTo dt:CDCoding.codingRationale. fhir:Coding.userSelected fhir:hasMap fhir:Coding.userSelected.map. fhir:Coding.userSelected.map a fhir:Map; fhir:target dt:CDCoding.codingRationale. fhir:Coding.userSelected\#true a [ fhir:source "true"; fhir:target dt:CDCoding.codingRationale\#O ]

Specimen.collection.bodySite.text Σ

Short Plain text representation of the concept

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.

Cardinality 0..1

Type

string

Summary True

Requirements

Comments

Very often the text is the same as a displayName of one of the codings.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: C*E.9. But note many systems use C*E.2 for this
rim: ./originalText[mediaType/code="text/plain"]/data
orim: fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText

Specimen.collection.fastingStatus[x] Σ

Short Whether or how long patient abstained from food and/or drink

Definition

Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.

Cardinality 0..1

Type CodeableConcept | Duration

Binding

Codes describing the fasting status of the patient.

v2.0916 (extensible)

Summary True

Requirements

Many diagnostic tests require fasting to facilitate accurate interpretation.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: OBR-

Specimen.processing

Short Processing and processing step details

Definition

Details concerning processing and processing steps for the specimen.

Cardinality 0..*

Type

BackboneElement

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]

Specimen.processing.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.processing.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.processing.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.processing.description

Short Textual description of procedure

Definition

Textual description of procedure.

Cardinality 0..1

Type

string

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .text

Specimen.processing.procedure

Short Indicates the treatment step applied to the specimen

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

Type indicating the technique used to process the specimen.

SpecimenProcessingProcedure (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
rim: .code

Specimen.processing.additive C

Short Material used in the processing step

Definition

Material used in the processing step.

Cardinality 0..*

Type Reference(Substance)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: SPM-6
rim: .participation[typeCode=CSM].role[classCode=ADTV].code

Specimen.processing.time[x]

Short Date and time of specimen processing

Definition

A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin.

Cardinality 0..1

Type dateTime | Period

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .effectiveTime

Specimen.container

Short Direct container of specimen (tube/slide, etc.)

Definition

The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here.

Cardinality 0..*

Type

BackboneElement

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .player.scopingRole[classCode=CONT].scoper

Specimen.container.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.container.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.container.modifierExtension Σ ?! C

Short Extensions that cannot be ignored even if unrecognized

Definition

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality 0..*

Type

Extension

Modifier True

Summary True

Alias extensions, user content, modifiers

Requirements

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.container.identifier Σ

Short Id for the container

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.

Cardinality 0..*

Type

Identifier

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
servd: Identifier
v2: SAC-3
rim: .id

Specimen.container.identifier.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.container.identifier.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.container.identifier.use Σ ?!

Short usual | official | temp | secondary | old (If known)

Definition

The purpose of this identifier.

Cardinality 0..1

Type

code

Binding

Identifies the purpose for this identifier, if known .

IdentifierUse (required)

Modifier True

Summary True

Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Role.code or implied by context

Specimen.container.identifier.type Σ

Short Description of identifier

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

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

IdentifierTypeCodes (extensible)

Summary True

Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: CX.5
rim: Role.code or implied by context

Specimen.container.identifier.system Σ

Short The namespace for the identifier value

Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Cardinality 0..1

Type

uri

Summary True

Requirements

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

Comments

Identifier.system is always case sensitive.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

http://www.acme.com/identifiers/patient

Mappings

rim: n/a
v2: CX.4 / EI-2-4
rim: II.root or Role.id.root
servd: ./IdentifierType

Specimen.container.identifier.value Σ

Short The value that is unique

Definition

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

Cardinality 0..1

Type

string

Summary True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Examples

General

Mappings

rim: n/a
v2: CX.1 / EI.1
rim: II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
servd: ./Value

Specimen.container.identifier.period Σ C

Short Time period when id is/was valid for use

Definition

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

Cardinality 0..1

Type

Period

Summary True

Comments

Period is not used for a duration (a measure of elapsed time). See Duration.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
per-1: If present, start SHALL have a lower value than end
start.hasValue().not() or end.hasValue().not() or (start <= end)

Mappings

rim: n/a
v2: DR
rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
v2: CX.7 + CX.8
rim: Role.effectiveTime or implied by context
servd: ./StartDate and ./EndDate

Specimen.container.identifier.assigner Σ C

Short Organization that issued id (may be just text)

Definition

Organization that issued/manages the identifier.

Cardinality 0..1

Type Reference(CareConnect-GPC-Organization-1)

Summary True

Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ref-1: SHALL have a contained resource if a local reference is provided
reference.exists() implies (reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids')) or (reference='#' and %rootResource!=%resource))

Mappings

rim: n/a
rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
v2: CX.4 / (CX.4,CX.9,CX.10)
rim: II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
servd: ./IdentifierIssuingAuthority

Specimen.container.description

Short Textual description of the container

Definition

Textual description of the container.

Cardinality 0..1

Type

string

Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
rim: .desc

Specimen.container.type

Short Kind of container directly associated with specimen

Definition

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

Cardinality 0..1

Type

CodeableConcept

Binding

Type of specimen container.

SpecimenContainerType (example)

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-27
rim: .code

Specimen.container.capacity C

Short Container volume or size

Definition

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

Cardinality 0..1

Type

SimpleQuantity

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20
rim: .quantity

Specimen.container.specimenQuantity C

Short Quantity of specimen within container

Definition

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

Cardinality 0..1

Type

SimpleQuantity

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.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
qty-3: If a code for the unit is present, the system SHALL also be present
code.empty() or system.exists()
sqty-1: The comparator is not used on a SimpleQuantity
comparator.empty()

Mappings

rim: n/a
v2: SN (see also Range) or CQ
rim: PQ, IVL<PQ>, MO, CO, depending on the values
v2: SAC-23 (value) SAC-24 (units
rim: .playedRole[classCode=CONT].quantity

Specimen.container.additive[x]

Short Additive associated with container

Definition

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

Cardinality 0..1

Type CodeableConcept | Reference(Substance)

Binding

Substance added to specimen container.

v2.0371 (example)

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: SAC-27
rim: .scopesRole[classCode=ADTV].player

Specimen.condition Σ

Short State of the specimen

Definition

A mode or state of being that describes the nature of the specimen.

Cardinality 0..*

Type

CodeableConcept

Binding

Codes describing the state of the specimen.

v2.0493 (extensible)

Summary True

Requirements

The specimen condition can be used to assess its quality or appropriateness for a specific test.

Comments

Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: CE/CNE/CWE
rim: CD
orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
v2: SPM-24

Specimen.note S

Short Notes/comments relating to the specimen.

Definition

To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen).

Cardinality 0..1

Type

Annotation

Must Support True

Comments

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act
v2: OBX
rim: .inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code="annotation"].value

Specimen.note.id

Short Unique id for inter-element referencing

Definition

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

Cardinality 0..1

Type

string

Mappings

rim: n/a

Specimen.note.extension C

Short Additional content defined by implementations

Definition

Cardinality 0..*

Type

Extension

Alias extensions, user content

Comments

Slicing

Unordered, Open, by url(Value)

Extensions are always sliced by (at least) url

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

ele-1: All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
ext-1: Must have either extensions or value[x], not both
extension.exists() != value.exists()

Mappings

rim: n/a
rim: N/A

Specimen.note.author[x] Σ

Short Individual responsible for the annotation

Definition

The individual responsible for making the annotation.

Cardinality 0..1

Type Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1) | Reference(https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1) | string

Summary True

Comments

Organization is used when there's no need for specific attribution as to who made the comment.

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.participant[typeCode=AUT].role

Specimen.note.time Σ

Short When the annotation was made

Definition

Indicates when this particular annotation was made.

Cardinality 0..1

Type

dateTime

Summary True

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.effectiveTime

Specimen.note.text Σ

Short The annotation - text content (as markdown)

Definition

The text of the annotation in markdown format.

Cardinality 1..1

Type

markdown

Summary True

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Conditions The cardinality or value of this element may be affected by these constraints: ele-1

Constraints

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

Mappings

rim: n/a
v2: N/A
rim: Act.text

<url value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1" />
<version value="1.3.0" />
<name value="CareConnect-GPC-Specimen-1" />
<status value="draft" />
<date value="2020-02-17" />
<publisher value="HL7 UK" />
<contact>
<name value="INTEROPen" />
<telecom>
<system value="email" />
<value value="admin@interopen.org" />
<use value="work" />
</telecom>
</contact>
<description value="Specimen" />
<copyright value="Copyright © 2020 HL7 UK\n \nLicensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n \nhttp://www.apache.org/licenses/LICENSE-2.0\n \nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n \nHL7® FHIR® standard Copyright © 2011+ HL7\n \nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n \nhttps://www.hl7.org/fhir/license.html" />
<fhirVersion value="3.0.2" />
<kind value="resource" />
<abstract value="false" />
<type value="Specimen" />
<baseDefinition value="http://hl7.org/fhir/StructureDefinition/Specimen" />
<derivation value="constraint" />
<differential>
<element id="Specimen.meta">
<path value="Specimen.meta" />
</element>
<element id="Specimen.meta.profile">
<path value="Specimen.meta.profile" />
<min value="1" />
</element>
<element id="Specimen.identifier">
<path value="Specimen.identifier" />
<min value="1" />
</element>
<element id="Specimen.identifier.system">
<path value="Specimen.identifier.system" />
<min value="1" />
</element>
<element id="Specimen.identifier.value">
<path value="Specimen.identifier.value" />
<min value="1" />
</element>
<element id="Specimen.accessionIdentifier">
<path value="Specimen.accessionIdentifier" />
<short value="A business level identifier for the specimen supplied by the performing organisation. eg. lab performing the test." />
<mustSupport value="true" />
</element>
<element id="Specimen.accessionIdentifier.assigner">
<path value="Specimen.accessionIdentifier.assigner" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="Specimen.status">
<path value="Specimen.status" />
<mustSupport value="true" />
</element>
<element id="Specimen.type">
<path value="Specimen.type" />
<mustSupport value="true" />
</element>
<element id="Specimen.type.coding">
<path value="Specimen.type.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="Specimen.type.coding:snomedCT">
<path value="Specimen.type.coding" />
<sliceName value="snomedCT" />
<binding>
<strength value="extensible" />
<description value="A code from the SNOMED Clinical Terminology UK" />
</binding>
</element>
<element id="Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Specimen.type.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="Specimen.type.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="Specimen.type.coding:snomedCT.system">
<path value="Specimen.type.coding.system" />
<min value="1" />
</element>
<element id="Specimen.type.coding:snomedCT.code">
<path value="Specimen.type.coding.code" />
<min value="1" />
</element>
<element id="Specimen.type.coding:snomedCT.display">
<path value="Specimen.type.coding.display" />
<min value="1" />
</element>
<element id="Specimen.subject">
<path value="Specimen.subject" />
<short value="A reference to the Patient who the observation is about." />
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Group" />
</type>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Device" />
</type>
<type>
<code value="Reference" />
<targetProfile value="http://hl7.org/fhir/StructureDefinition/Substance" />
</type>
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1" />
</type>
</element>
<element id="Specimen.receivedTime">
<path value="Specimen.receivedTime" />
<mustSupport value="true" />
</element>
<element id="Specimen.parent">
<path value="Specimen.parent" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1" />
</type>
</element>
<element id="Specimen.request">
<path value="Specimen.request" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1" />
</type>
</element>
<element id="Specimen.collection">
<path value="Specimen.collection" />
<short value="Details of when/how the specimen was collected." />
<mustSupport value="true" />
</element>
<element id="Specimen.collection.extension:fastingStatus">
<path value="Specimen.collection.extension" />
<sliceName value="fastingStatus" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Specimen.collection.extension:fastingStatus.url">
<path value="Specimen.collection.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1" />
</element>
<element id="Specimen.collection.collector">
<path value="Specimen.collection.collector" />
<short value="Reference to the resource for the Practitioner that collected the specimen." />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1" />
</type>
<mustSupport value="true" />
</element>
<element id="Specimen.collection.collected[x]">
<path value="Specimen.collection.collected[x]" />
<short value="The date and time when the specimen was collected." />
<mustSupport value="true" />
</element>
<element id="Specimen.collection.quantity">
<path value="Specimen.collection.quantity" />
<mustSupport value="true" />
</element>
<element id="Specimen.collection.bodySite">
<path value="Specimen.collection.bodySite" />
<mustSupport value="true" />
</element>
<element id="Specimen.collection.bodySite.coding">
<path value="Specimen.collection.bodySite.coding" />
<slicing>
<discriminator>
<type value="value" />
<path value="system" />
</discriminator>
<rules value="open" />
</slicing>
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT">
<path value="Specimen.collection.bodySite.coding" />
<sliceName value="snomedCT" />
<binding>
<strength value="extensible" />
<description value="A code from the SNOMED Clinical Terminology UK" />
</binding>
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID">
<path value="Specimen.collection.bodySite.coding.extension" />
<sliceName value="snomedCTDescriptionID" />
<type>
<code value="Extension" />
<profile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</type>
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url">
<path value="Specimen.collection.bodySite.coding.extension.url" />
<fixedUri value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT.system">
<path value="Specimen.collection.bodySite.coding.system" />
<min value="1" />
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT.code">
<path value="Specimen.collection.bodySite.coding.code" />
<min value="1" />
</element>
<element id="Specimen.collection.bodySite.coding:snomedCT.display">
<path value="Specimen.collection.bodySite.coding.display" />
<min value="1" />
</element>
<element id="Specimen.container.identifier.assigner">
<path value="Specimen.container.identifier.assigner" />
<type>
<code value="Reference" />
<targetProfile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1" />
</type>
</element>
<element id="Specimen.note">
<path value="Specimen.note" />
<short value="Notes/comments relating to the specimen." />
<max value="1" />
<mustSupport value="true" />
</element>
<element id="Specimen.note.author[x]">
<path value="Specimen.note.author[x]" />
<type>
<code value="string" />
</type>
<type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1" />
</type>
<type>
<code value="Reference" />
<targetProfile value="https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1" />
</type>
</element>
</differential>

</StructureDefinition>

{

"resourceType": "StructureDefinition",
"url": "https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1",
"version": "1.3.0",
"name": "CareConnect-GPC-Specimen-1",
"status": "draft",
"date": "2020-02-17",
"publisher": "HL7 UK",
"contact": [
{
"name": "INTEROPen",
"telecom": [
{
"system": "email",
"value": "admin@interopen.org",
"use": "work"
}
]
}
],
"description": "Specimen",
"copyright": "Copyright © 2020 HL7 UK\n \nLicensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at\n \nhttp://www.apache.org/licenses/LICENSE-2.0\n \nUnless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.\n \nHL7® FHIR® standard Copyright © 2011+ HL7\n \nThe HL7® FHIR® standard is used under the FHIR license. You may obtain a copy of the FHIR license at\n \nhttps://www.hl7.org/fhir/license.html",
"fhirVersion": "3.0.2",
"kind": "resource",
"abstract": false,
"type": "Specimen",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Specimen",
"derivation": "constraint",
"differential": {
"element": [
{
"id": "Specimen.meta",
"path": "Specimen.meta"
},
{
"id": "Specimen.meta.profile",
"path": "Specimen.meta.profile",
"min": 1
},
{
"id": "Specimen.identifier",
"path": "Specimen.identifier",
"min": 1
},
{
"id": "Specimen.identifier.system",
"path": "Specimen.identifier.system",
"min": 1
},
{
"id": "Specimen.identifier.value",
"path": "Specimen.identifier.value",
"min": 1
},
{
"id": "Specimen.accessionIdentifier",
"path": "Specimen.accessionIdentifier",
"short": "A business level identifier for the specimen supplied by the performing organisation. eg. lab performing the test.",
"mustSupport": true
},
{
"id": "Specimen.accessionIdentifier.assigner",
"path": "Specimen.accessionIdentifier.assigner",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "Specimen.status",
"path": "Specimen.status",
"mustSupport": true
},
{
"id": "Specimen.type",
"path": "Specimen.type",
"mustSupport": true
},
{
"id": "Specimen.type.coding",
"path": "Specimen.type.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "Specimen.type.coding:snomedCT",
"path": "Specimen.type.coding",
"sliceName": "snomedCT",
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SpecimenType-1"
},
"strength": "extensible",
"description": "A code from the SNOMED Clinical Terminology UK"
}
},
{
"id": "Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Specimen.type.coding.extension",
"sliceName": "snomedCTDescriptionID",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Specimen.type.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Specimen.type.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "Specimen.type.coding:snomedCT.system",
"path": "Specimen.type.coding.system",
"min": 1
},
{
"id": "Specimen.type.coding:snomedCT.code",
"path": "Specimen.type.coding.code",
"min": 1
},
{
"id": "Specimen.type.coding:snomedCT.display",
"path": "Specimen.type.coding.display",
"min": 1
},
{
"id": "Specimen.subject",
"path": "Specimen.subject",
"short": "A reference to the Patient who the observation is about.",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Group"
]
},
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Device"
]
},
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/StructureDefinition/Substance"
]
},
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Patient-1"
]
}
]
},
{
"id": "Specimen.receivedTime",
"path": "Specimen.receivedTime",
"mustSupport": true
},
{
"id": "Specimen.parent",
"path": "Specimen.parent",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Specimen-1"
]
}
]
},
{
"id": "Specimen.request",
"path": "Specimen.request",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-ProcedureRequest-1"
]
}
]
},
{
"id": "Specimen.collection",
"path": "Specimen.collection",
"short": "Details of when/how the specimen was collected.",
"mustSupport": true
},
{
"id": "Specimen.collection.extension:fastingStatus",
"path": "Specimen.collection.extension",
"sliceName": "fastingStatus",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1"
]
}
],
"mustSupport": true
},
{
"id": "Specimen.collection.extension:fastingStatus.url",
"path": "Specimen.collection.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1"
},
{
"id": "Specimen.collection.collector",
"path": "Specimen.collection.collector",
"short": "Reference to the resource for the Practitioner that collected the specimen.",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
]
}
],
"mustSupport": true
},
{
"id": "Specimen.collection.collected[x]",
"path": "Specimen.collection.collected[x]",
"short": "The date and time when the specimen was collected.",
"mustSupport": true
},
{
"id": "Specimen.collection.quantity",
"path": "Specimen.collection.quantity",
"mustSupport": true
},
{
"id": "Specimen.collection.bodySite",
"path": "Specimen.collection.bodySite",
"mustSupport": true
},
{
"id": "Specimen.collection.bodySite.coding",
"path": "Specimen.collection.bodySite.coding",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "system"
}
],
"rules": "open"
}
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT",
"path": "Specimen.collection.bodySite.coding",
"sliceName": "snomedCT",
"binding": {
"valueSetReference": {
"reference": "https://fhir.hl7.org.uk/STU3/ValueSet/CareConnect-SpecimenBodySite-1"
},
"strength": "extensible",
"description": "A code from the SNOMED Clinical Terminology UK"
}
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID",
"path": "Specimen.collection.bodySite.coding.extension",
"sliceName": "snomedCTDescriptionID",
"type": [
{
"code": "Extension",
"profile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
]
}
]
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT.extension:snomedCTDescriptionID.url",
"path": "Specimen.collection.bodySite.coding.extension.url",
"fixedUri": "https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid"
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT.system",
"path": "Specimen.collection.bodySite.coding.system",
"min": 1
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT.code",
"path": "Specimen.collection.bodySite.coding.code",
"min": 1
},
{
"id": "Specimen.collection.bodySite.coding:snomedCT.display",
"path": "Specimen.collection.bodySite.coding.display",
"min": 1
},
{
"id": "Specimen.container.identifier.assigner",
"path": "Specimen.container.identifier.assigner",
"type": [
{
"code": "Reference",
"targetProfile": [
"https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Organization-1"
]
}
]
},
{
"id": "Specimen.note",
"path": "Specimen.note",
"short": "Notes/comments relating to the specimen.",
"max": "1",
"mustSupport": true
},
{
"id": "Specimen.note.author[x]",
"path": "Specimen.note.author[x]",
"type": [
{
"code": "string"
},
{
"code": "Reference",
"targetProfile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Practitioner-1"
]
},
{
"code": "Reference",
"targetProfile": [
"https://fhir.hl7.org.uk/STU3/StructureDefinition/CareConnect-Patient-1"
]
}
]
}
]
}

}

Command 'details' could not render: There is no placeholder called 'details'

Reference

Canonical URI: https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1

The canonical URI is the stable FHIR identifier for this profile and is not currently available as a browsable web page.

Element	Use	CareConnect (STU3)	UK Core (R4)
id
meta.versionId
meta.lastUpdated
meta.profile
meta.security
meta.tag
identifier
accessionIdentifier
status
type
subject
receivedTime
parent
request
collection.extension(fastingStatus)
collection.collector
collection.collector
collection.quantity
collection.method
collection.bodySite
processing
container
note

id

Usage

Optional

Guidance

The id is the logical identifier for the CareConnect-GPC-Specimen-1 profile.

Example

<id value="5f2ba1c0-fb1b-4415-90e5-37ae8e03331f" />

meta.versionId

Usage

Optional

Guidance

The population of the meta.versionId element could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.

Example

<meta>
    <versionId value="1" />
</meta>

meta.lastUpdated

Usage

Optional

Guidance

The meta.lastUpdated element could be useful alongside the meta.versionIdelement could be useful if sending an adendum of something previously sent to help the consumer (receiver) in understanding there is a "newer" version.

Example

<meta>
    <lastUpdated value="2022-10-28T08:06:00+00:00" />
</meta>

meta.profile

Usage

Mandatory

Guidance

The meta.profile contains a fixed value of the URL for the CareConnect-GPC-Specimen-1 profile.

Example

<meta>
    <profile value="https://fhir.nhs.uk/STU3/StructureDefinition/CareConnect-GPC-Specimen-1" />
</meta>

meta.security

Usage

Optional

Guidance

The security label(s) applicable to the resource.

See Resources not to be disclosed to a patient for more details on how to populate the element.

Example

<meta>
    <security>
        <system value="http://hl7.org/fhir/v3/ActCode"/>
        <code value="NOPAT"/>
        <display value="no disclosure to patient, family or caregivers without attending provider's authorization"/>
    </security>
</meta>

meta.tag

Usage

Optional

Guidance

A use-case for the meta.tag element within GP Connect has not been defined.

Example

<meta>
    <tag>
        <coding>
            <system value="http://hl7.org/fhir/common-tags" />
            <code value="actionable" />
            <display value="Actionable" />
        </coding>
    </tag>
</meta>

identifier

Usage

Mandatory

Guidance

The identifier element MUST be populated with a globally unique and persistent identifier (that is, it doesn’t change between requests and therefore stored with the source data). This MUST be scoped by a provider specific namespace for the identifier.

Where consuming systems are integrating data from this resource to their local system, they MUST also persist this identifier at the same time.

Example

<identifier>
    <system value="https://foo.bar/id/specimen" />
    <value value="fef26348-ccd1-440b-940e-ba1ec058cf21" />
</identifier>

accessionIdentifier

Usage

Required

Guidance

A business level identifier for the specimen supplied by the performing organisation - for example, the lab performing the test.

Example

<accessionIdentifier>
    <system value="https://foo.bar/id/specimen-accession" />
    <value value="2772e6f3-d0cf-40b5-b043-aa63cc7f875b" />
</identifier>

status

Usage

Required

Guidance

The availability of the specimen.

Example

<status value="available" />

type

Usage

Required

Guidance

The kind of material that forms the specimen. Examples can be found using the link below.

87612001 | Blood (substance) |

Example

<code>
    <coding>
        <display value="53130003 | Venous blood (substance) |" />
        <code value="53130003" />
        <system value="http://snomed.info/sct" />
        <snomedCT>
            <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-coding-sctdescid" />
            <extension>
            <valueId value="53130003" />
                <descriptionId value="53130003" />
                <descriptionDisplay value="Venous blood (substance)" />
            </extesion>
        </snomedCT>
    </coding>
    <text value="Venous blood is deoxygenated blood which travels from the peripheral blood vessels, through the venous system into the right atrium of the heart." />
</code>
---

subject

Usage

Mandatory

Guidance

A reference to the patient whom the specimen is regarding.

Example

<subject>
    <reference value="patient-001sfg934" />
</subject>

receivedTime

Usage

Required

Guidance

The time when specimen was received for processing.

Example

<receviedTime value="2022-12-05T11:10:00Z" />

collection.extension(fastingStatus)

Usage

Required

Guidance

Whether or how long patient abstained from food and/or drink.

Where this is indicated in the incoming EDIFACT report it will be indicated with an ‘F’. In this scenario:

This MUST be used to populate the coding.text element
This SHOULD be used to populate the coding element with values for the ‘F’ code from the relevantClincialInformation ValueSet

Example

<collection>
    <extension>
        <url value="https://fhir.hl7.org.uk/STU3/StructureDefinition/Extension-CareConnect-FastingStatus-1" />
        <valueCodeableConcept>
            <coding>
                <display value="Patient was fasting prior to the procedure." />
                <code value="F" />
                <system value="http://terminology.hl7.org/CodeSystem/v2-0916" />
            </coding>
            <text value="Patient was fasting prior to the procedure." />
        </valueCodeableConcept>
    </extension>
</collection>

collection.collector

Usage

Required

Guidance

A reference to the resource for the practitioner who collected the specimen.

Example

<collection>
    <collector>
        <reference value="practitioner-00192ods" />
    </collector>
</collection>

collection.collected

Usage

Required

Guidance

The date and time when the specimen was collected.

Example

<collection>
    <collected value="2022-12-05T13:17:00Z" />
</collection>

collection.quantity

Usage

Required

Guidance

The quantity of the specimen that was collected.

Example

<collection>
    <quantity>
        <value value="10" />
        <unit value="milliliter" />
        <system value="http://unitsofmeasure.org" />
        <code value="mL" />
    </quantity>
</collection>

collection.bodySite

Usage

Required

Guidance

The anatomical site of the specimen collection.

Example

<collection>
    <bodySite>
        <coding>
            <system value="http://snomed.info/sct" />
            <code value="6757004" />
            <display value="Structure of right knee region (body structure)" />
        </coding>
    </bodySite>
</collection>

note

Usage

Required

Guidance

Any notes relating to the specified specimen.

Example

<note>
    <author>
        <reference value="practitioner-948392" />
    </author>
    <time value="2022-10-13T16:59:00Z" />
    <text>
        Free text... R4 of the FHIR standard supports GitHub Flavoured Markdown (GFM).
    </text>
</note>

Copy of 'GP Connect Data Model | FHIR STU3 Representation'

Profile: CareConnect-GPC-Specimen-1

Reference

Related links

id

Usage

Guidance

Example

meta.versionId

Usage

Guidance

Example

meta.lastUpdated

Usage

Guidance

Example

meta.profile

Usage

Guidance

Example

meta.security

Usage

Guidance

Example

meta.tag

Usage

Guidance

Example

identifier

Usage

Guidance

Example

accessionIdentifier

Usage

Guidance

Example

status

Usage

Guidance

Example

type

Usage

Guidance

Example

subject

Usage

Guidance

Example

receivedTime

Usage

Guidance

Example

collection.extension(fastingStatus)

Usage

Guidance

Example

collection.collector

Usage

Guidance

Example

collection.collected

Usage

Guidance

Example

collection.quantity

Usage

Guidance

Example

collection.bodySite

Usage

Guidance

Example

note

Usage

Guidance

Example

Elements not in use

parent

request

collection.method