This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Todo
Definitions for the spec-uslab-uslabspec Profile.
Specimen(USLabSpec) | |
Definition | Specimen resource defined for the USLab Implementation Guides. |
Control | 1..1 |
Requirements | |
Alternate Names | Sample |
Comments | |
Specimen.id | |
Definition | The logical id of the resource, as used in the url for the resoure. Once assigned, this value never changes. |
Control | 0..1 |
Type | id |
Requirements | |
Comments | The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID. |
Specimen.meta | |
Definition | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource. |
Control | 0..1 |
Type | Meta |
Requirements | |
Comments | |
Specimen.implicitRules | |
Definition | A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
Control | 0..1 |
Type | uri |
Is Modifier | true |
Requirements | |
Comments | Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible. |
Specimen.language | |
Definition | The base language in which the resource is written. |
Control | 0..1 |
Binding | A human language The codes SHALL be taken from http://tools.ietf.org/html/bcp47 |
Type | code |
Requirements | |
Comments | Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute). |
Specimen.text | |
Definition | A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety. |
Control | 0..1 This element is affected by the following invariants: dom-1 |
Type | Narrative |
Requirements | |
Alternate Names | narrative, html, xhtml, display |
Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. |
Specimen.contained | |
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. |
Control | 0..* |
Type | Resource |
Requirements | |
Alternate Names | inline resources, anonymous resources, contained resources |
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. |
Specimen.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.identifier | |
Definition | Id for specimen. |
Control | 0..* |
Type | Identifier |
Requirements | |
Comments | |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Specimen.identifier(USLabPlacerSID) | |
Definition | Id for specimen. |
Control | 0..1 |
Type | Identifier |
Must Support | true |
Requirements | |
Comments | |
Specimen.identifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.identifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.identifier.use | |
Definition | The purpose of this identifier. |
Control | 1..1 |
Binding | Identifies the purpose for this identifier, if known The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Fixed Value | official |
Specimen.identifier.label | |
Definition | A text string for the identifier that can be displayed to a human so they can recognize the identifier. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | Allows humans to make use of identifiers when the identifier system is not known. |
Comments | |
Fixed Value | Placer Specimen ID |
Specimen.identifier.system | |
Definition | Placer URI. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
Specimen.identifier.value | |
Definition | Placer Identifier. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 123456 |
Specimen.identifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Specimen.identifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | The reference may be just a text description of the assigner. |
Specimen.type | |
Definition | The kind of material that forms the specimen. |
Control | 1..1 |
Binding | The type of the specimen. For example codes, see v2 Specimen Type |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Comments | The type can change the way that a specimen is handled, and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems. |
Specimen.type.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.type.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.type.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Specimen.type.coding(USLabSNOMEDCTCoding) | |
Definition | SNOMED-CT coding if available. |
Control | 0..1 |
Binding | Codes to describe the Specimen The codes SHALL be taken from USLabSpecimenType; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | Snomed Code |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Specimen.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.type.coding.system | |
Definition | SNOMED-CT Coding System. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Specimen.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Specimen.type.coding.code | |
Definition | SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Specimen.type.coding.display | |
Definition | The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/). |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Specimen.type.coding.primary | |
Definition | Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact code 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. |
Specimen.type.coding.valueSet | |
Definition | The set of possible coded values this coding was chosen from or constrained by. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet)) |
Requirements | The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare. |
Comments | |
Specimen.type.coding(USLabLocalCoding) | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | Local |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Specimen.type.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.type.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.type.coding.system | |
Definition | This is defined locally. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Specimen.type.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Specimen.type.coding.code | |
Definition | Local Code. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Specimen.type.coding.display | |
Definition | This is defined locally. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Specimen.type.coding.primary | |
Definition | Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact code 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. |
Specimen.type.coding.valueSet | |
Definition | The set of possible coded values this coding was chosen from or constrained by. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet)) |
Requirements | The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare. |
Comments | |
Specimen.type.text | |
Definition | This is the laboratory defined display text for the actual test result, if different from the code display names. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Specimen.parent | |
Definition | Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of a another specimen. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Specimen)) |
Requirements | |
Comments | The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample. |
Specimen.subject | |
Definition | Patient. |
Control | 1..1 |
Type | Choice of: Reference(Profile = (Profile = http://hl7.org/fhir/Profile/patient-uslab-uslabpatient)), Reference(Profile = (Profile = http://hl7.org/fhir/Profile/patient-uslab-uslabphpatient)) |
Must Support | true |
Requirements | Must know the subject context. |
Alternate Names | Patient |
Comments | |
Specimen.accessionIdentifier | |
Definition | The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures. |
Control | 1..1 |
Type | Identifier |
Must Support | true |
Requirements | |
Alternate Names | Filler ID |
Comments | |
Specimen.accessionIdentifier.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.accessionIdentifier.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.accessionIdentifier.use | |
Definition | The purpose of this identifier. |
Control | 1..1 |
Binding | Identifies the purpose for this identifier, if known The codes SHALL be taken from IdentifierUse |
Type | code |
Is Modifier | true |
Must Support | true |
Requirements | Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers. |
Comments | This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary. |
Fixed Value | official |
Specimen.accessionIdentifier.label | |
Definition | A text string for the identifier that can be displayed to a human so they can recognize the identifier. |
Control | 0..1 |
Type | string |
Requirements | Allows humans to make use of identifiers when the identifier system is not known. |
Comments | |
Specimen.accessionIdentifier.system | |
Definition | Filler URI. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | There are many sequences of identifiers. To perform matching, we need to know what sequence we're dealing with. The system identifies a particular sequence or set of unique identifiers. |
Comments | |
Example | http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the id itself is a full uri |
Specimen.accessionIdentifier.value | |
Definition | Filler Identifier. |
Control | 1..1 |
Type | string |
Must Support | true |
Requirements | |
Comments | If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. |
Example | 123456 |
Specimen.accessionIdentifier.period | |
Definition | Time period during which identifier is/was valid for use. |
Control | 0..1 |
Type | Period |
Requirements | |
Comments | |
Specimen.accessionIdentifier.assigner | |
Definition | Organization that issued/manages the identifier. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Organization)) |
Requirements | |
Comments | The reference may be just a text description of the assigner. |
Specimen.receivedTime | |
Definition | Time when specimen was received for processing or testing. |
Control | 0..1 |
Type | dateTime |
Requirements | |
Comments | |
Specimen.collection | |
Definition | Details concerning the specimen collection. |
Control | 1..1 |
Must Support | true |
Requirements | |
Comments | |
Specimen.collection.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.collection.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.collector | |
Definition | Person who collected the specimen. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Practitioner)) |
Requirements | |
Comments | |
Specimen.collection.comment | |
Definition | To communicate any details or issues encountered during the specimen collection procedure. |
Control | 0..* |
Type | string |
Requirements | |
Comments | |
Specimen.collection.collected[x] | |
Definition | Time when specimen was collected from subject - the physiologically relevant time. |
Control | 1..1 |
Type | Choice of: dateTime, Period |
Must Support | true |
Requirements | |
Comments | |
Invariants | Defined on this element inv-2: Datetime must be at least to the day. (xpath: f:matches(.,/\d{4}-[01]\d-[0-3])/)) |
Specimen.collection.quantity | |
Definition | The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample. |
Control | 0..1 |
Type | Quantity |
Requirements | |
Comments | |
Specimen.collection.method | |
Definition | A coded value specifying the technique that is used to perform the procedure. |
Control | 0..1 |
Binding | The technique that is used to perform the procedure For example codes, see SpecimenCollectionMethod |
Type | CodeableConcept |
Requirements | |
Comments | |
Specimen.collection.bodySiteCodeableConcept | |
Definition | Anatomical location from which the specimen was collected (if subject is a patient). This element is not used for environmental specimens. |
Control | 0..1 |
Binding | Codes describing anatomical locations. May include laterality For example codes, see SNOMED CT Body Structures |
Type | CodeableConcept |
Must Support | true |
Requirements | |
Comments | |
Specimen.collection.bodySiteCodeableConcept.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.collection.bodySiteCodeableConcept.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.bodySiteCodeableConcept.coding | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..* |
Type | Coding |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Slicing | This element introduces a set of slices. The slicing rules are:
|
Specimen.collection.bodySiteCodeableConcept.coding(USLabSNOMEDCTCoding) | |
Definition | SNOMED-CT coding if available. |
Control | 0..1 |
Binding | Codes to describe the Specimen Collection Body site The codes SHALL be taken from SNOMED CT Body Structures; other codes may be used where these codes are not suitable |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | Snomed Code |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Specimen.collection.bodySiteCodeableConcept.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.bodySiteCodeableConcept.coding.system | |
Definition | SNOMED-CT Coding System. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Fixed Value | http://snomed.info/sct |
Specimen.collection.bodySiteCodeableConcept.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Specimen.collection.bodySiteCodeableConcept.coding.code | |
Definition | SNOMED Clinical Terms is a systematically organized computer processable collection of medical terms providing codes, terms, synonyms and definitions used in clinical documentation and reporting. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.display | |
Definition | The SNOMED-CT 'preferred name' is preferred although any SNOMED-CT 'synonym' can also be used. ( ihtsdo.org/snomed-ct/). |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.primary | |
Definition | Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact code 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. |
Specimen.collection.bodySiteCodeableConcept.coding.valueSet | |
Definition | The set of possible coded values this coding was chosen from or constrained by. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet)) |
Requirements | The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding(USLabLocalCoding) | |
Definition | A reference to a code defined by a terminology system. |
Control | 0..1 |
Type | Coding |
Must Support | true |
Requirements | Allows for translations and alternate encodings within a code system. Also supports communication of the same instance to systems requiring different encodings. |
Alternate Names | Local |
Comments | Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the V3 Core Principles for more information. Ordering of codings is undefined and SHALL not be used to infer meaning. |
Specimen.collection.bodySiteCodeableConcept.coding.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.collection.bodySiteCodeableConcept.coding.system | |
Definition | This is defined locally. |
Control | 1..1 |
Type | uri |
Must Support | true |
Requirements | Need to be unambiguous about the source of the definition of the symbol. |
Comments | The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously. |
Specimen.collection.bodySiteCodeableConcept.coding.version | |
Definition | The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date. |
Specimen.collection.bodySiteCodeableConcept.coding.code | |
Definition | Local Code. |
Control | 1..1 |
Type | code |
Must Support | true |
Requirements | Need to refer to a particular code in the system. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.display | |
Definition | This is defined locally. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | Need to be able to carry a human-readable meaning of the code for readers that do not know the system. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.coding.primary | |
Definition | Indicates that this code was chosen by a user directly - i.e. off a pick list of available items (codes or displays). |
Control | 0..1 |
Type | boolean |
Requirements | This has been identified as a clinical safety criterium - that this exact code 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. |
Specimen.collection.bodySiteCodeableConcept.coding.valueSet | |
Definition | The set of possible coded values this coding was chosen from or constrained by. |
Control | 0..1 |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/ValueSet)) |
Requirements | The value set may influence the codes that the user can select. Also, referencing the value set directly makes it easier to share ad-hoc code systems used across healthcare. |
Comments | |
Specimen.collection.bodySiteCodeableConcept.text | |
Definition | This is the laboratory defined display text for the actual test result, if different from the code display names. |
Control | 0..1 |
Type | string |
Must Support | true |
Requirements | The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source. |
Comments | Very often the text is the same as a displayName of one of the codings. |
Specimen.treatment | |
Definition | Details concerning treatment and processing steps for the specimen. |
Control | 0..* |
Requirements | |
Comments | |
Specimen.treatment.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.treatment.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.treatment.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.treatment.description | |
Definition | Textual description of procedure. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | |
Specimen.treatment.procedure | |
Definition | A coded value specifying the procedure used to process the specimen. |
Control | 0..1 |
Binding | Type indicating the technique used to process the specimen For example codes, see SpecimenTreatmentProcedure |
Type | CodeableConcept |
Requirements | |
Comments | |
Specimen.treatment.additive | |
Definition | Material used in the processing step. |
Control | 0..* |
Type | Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Substance)) |
Requirements | |
Comments | |
Specimen.container | |
Definition | The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here. |
Control | 0..* |
Requirements | |
Comments | |
Specimen.container.id | |
Definition | unique id for the element within a resource (for internal references). |
Control | 0..1 |
Type | id |
Requirements | |
Comments | |
Specimen.container.extension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.container.modifierExtension | |
Definition | May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. |
Control | 0..* |
Type | Extension |
Requirements | |
Alternate Names | extensions, user content, modifiers |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Specimen.container.identifier | |
Definition | 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. |
Control | 0..* |
Type | Identifier |
Requirements | |
Comments | |
Specimen.container.description | |
Definition | Textual description of the container. |
Control | 0..1 |
Type | string |
Requirements | |
Comments | |
Specimen.container.type | |
Definition | The type of container associated with the specimen (e.g. slide, aliquot, etc). |
Control | 0..1 |
Binding | Type of specimen container For example codes, see SpecimenContainer |
Type | CodeableConcept |
Requirements | |
Comments | |
Specimen.container.capacity | |
Definition | The capacity (volume or other measure) the container may contain. |
Control | 0..1 |
Type | Quantity |
Requirements | |
Comments | |
Specimen.container.specimenQuantity | |
Definition | The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type. |
Control | 0..1 |
Type | Quantity |
Requirements | |
Comments | |
Specimen.container.additive[x] | |
Definition | Introduced substance to preserve, maintain or enhance the specimen. examples: Formalin, Citrate, EDTA. |
Control | 0..1 |
Binding | Substance added to specimen container For example codes, see v2 Additive/Preservative |
Type | Choice of: CodeableConcept, Reference(Profile = (Profile = http://hl7.org/fhir/Profile/Substance)) |
Requirements | |
Comments |