| Left: | Specimen (IPS) (http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips) |
| Right: | US Core Specimen Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen) |
| Error | StructureDefinition.url | Values for url differ: 'http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips' vs 'http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen' |
| Error | StructureDefinition.version | Values for version differ: '2.0.0' vs '9.0.0-ballot' |
| Information | StructureDefinition.name | Values for name differ: 'SpecimenUvIps' vs 'USCoreSpecimenProfile' |
| Information | StructureDefinition.title | Values for title differ: 'Specimen (IPS)' vs 'US Core Specimen Profile' |
| Information | StructureDefinition.date | Values for date differ: '2024-06-19T10:50:07-05:00' vs '2023-10-17' |
| Information | StructureDefinition.publisher | Values for publisher differ: 'HL7 International / Patient Care' vs 'HL7 International / Cross-Group Projects' |
| Information | StructureDefinition.jurisdiction | Removed the item 'http://unstats.un.org/unsd/methods/m49/m49.htm#001' |
| Information | StructureDefinition.jurisdiction | Added the item 'urn:iso:std:iso:3166#US' |
| Information | StructureDefinition.short | Values for short differ: 'External Identifier' vs 'Specimen identifier' |
| Warning | Specimen.identifier | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Warning | Specimen.accessionIdentifier | Elements differ in definition for mustSupport: 'false' vs 'true' |
| Information | StructureDefinition.short | Values for short differ: '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' vs 'The patient where the specimen came from.' |
| Information | StructureDefinition.short | Values for short differ: 'Collection details' vs '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details' |
| Information | Specimen.collection.method | Example/preferred bindings differ at Specimen.collection.method using binding from SpecimenUvIps |
| Information | StructureDefinition.short | Values for short differ: 'Anatomical collection site' vs '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site' |
| Information | StructureDefinition.comment | Values for comment differ: '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](http://hl7.org/fhir/R4/extension-bodysite.html).' vs 'Body location from where a specimen was obtained. Examples include but are not limited to right internal jugular, left arm, and right eye.' |
| Information | StructureDefinition.short | Values for short differ: 'State of the specimen' vs '𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition' |
| Name | Value | Comments | |
|---|---|---|---|
abstract | false | ||
baseDefinition | http://hl7.org/fhir/StructureDefinition/Specimen | ||
copyright | Used by permission of HL7 International, all rights reserved Creative Commons License |
| |
date | 2024-06-19T10:50:07-05:00 | 2023-10-17 |
|
description | This profile constrains the Specimen resource to represent the characteristics of a biological specimens in the context of laboratory results integrated to a patient summary. | The US Core Specimen Profile inherits from the FHIR [Specimen](https://hl7.org/fhir/R4/specimen.html) resource; refer to it for scope and usage definitions. This profile sets minimum expectations for the Specimen resource to record, search, and fetch information about substances associated with a patient being sampled or tested (such as nasopharyngeal swab, whole blood, or serum). It specifies which core elements, extensions, vocabularies, and value sets **SHALL** be present and constrains how the elements are used. Providing the floor for standards development for specific use cases promotes interoperability and adoption. |
|
experimental | false |
| |
fhirVersion | 4.0.1 | ||
jurisdiction | |||
![]() jurisdiction[0] | http://unstats.un.org/unsd/methods/m49/m49.htm#001 |
| |
![]() jurisdiction[1] | urn:iso:std:iso:3166#US |
| |
kind | resource | ||
name | SpecimenUvIps | USCoreSpecimenProfile |
|
publisher | HL7 International / Patient Care | HL7 International / Cross-Group Projects |
|
purpose | Minimal specimen attributes, usable for the laboratory results section and entry of a patient summary. |
| |
status | active | ||
title | Specimen (IPS) | US Core Specimen Profile |
|
type | Specimen | ||
url | http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips | http://hl7.org/fhir/us/core/StructureDefinition/us-core-specimen |
|
version | 2.0.0 | 9.0.0-ballot |
|
| Name | L Flags | L Card. | L Type | L Description & Constraints | R Flags | R Card. | R Type | R Description & Constraints | Comments![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() | 0..* | Specimen | Sample for analysis | 0..* | Specimen | Sample for analysis | |||||||||||
![]() ![]() | Σ | 0..1 | id | Logical id of this artifact | Σ | 0..1 | id | Logical id of this artifact | |||||||||
![]() ![]() | Σ | 0..1 | Meta | Metadata about the resource | Σ | 0..1 | Meta | Metadata about the resource | |||||||||
![]() ![]() | ?!Σ | 0..1 | uri | A set of rules under which this content was created | ?!Σ | 0..1 | uri | A set of rules under which this content was created | |||||||||
![]() ![]() | 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| 0..1 | code | Language of the resource content Binding: ?? (preferred): A human language.
| |||||||||||
![]() ![]() | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | 0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||||||||
![]() ![]() | 0..* | Resource | Contained, inline Resources | 0..* | Resource | Contained, inline Resources | |||||||||||
![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() | ?! | 0..* | Extension | Extensions that cannot be ignored | ?! | 0..* | Extension | Extensions that cannot be ignored | |||||||||
![]() ![]() | Σ | 0..* | Identifier | External Identifier | SΣ | 0..* | Identifier | Specimen identifier |
| ||||||||
![]() ![]() | Σ | 0..1 | Identifier | Identifier assigned by the lab | SΣ | 0..1 | Identifier | Identifier assigned by the lab |
| ||||||||
![]() ![]() | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: ?? (required): Codes providing the status/availability of a specimen. | ?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: ?? (required): Codes providing the status/availability of a specimen. | |||||||||
![]() ![]() | SOΣ | 1..1 | ?? | Kind of material that forms the specimen Binding: ?? (preferred)
| SΣ | 1..1 | CodeableConcept | Kind of material that forms the specimen Binding: ?? (extensible) | |||||||||
![]() ![]() | SOΣ | 0..1 | Reference(Patient (IPS)) | 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
| SΣ | 0..1 | Reference(US Core Patient Profile S | Group | US Core Device Profile | Substance | US Core Location Profile) | The patient where the specimen came from. | |||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing |
| |||||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url |
| |||||||||||||
![]() ![]() ![]() | SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
|
| ||||||||||||
![]() ![]() ![]() | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ?? (extensible): Aa resource (or, for logical models, the URI of the logical model). |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| ||||||||||||
![]() ![]() ![]() | Σ | 0..1 | string | Text alternative for the resource |
| ||||||||||||
![]() ![]() | Σ | 0..1 | dateTime | The time when specimen was received for processing | Σ | 0..1 | dateTime | The time when specimen was received for processing | |||||||||
![]() ![]() | 0..* | Reference(Specimen) | Specimen from which this specimen originated | 0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||||
![]() ![]() | 0..* | Reference(ServiceRequest) | Why the specimen was collected | 0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||||||||
![]() ![]() | 0..1 | BackboneElement | Collection details | 0..1 | BackboneElement | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Collection details | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | |||||||||
![]() ![]() ![]() | Σ | 0..1 | dateTime, Period | Collection time | Σ | 0..1 | dateTime, Period | Collection time | |||||||||
![]() ![]() ![]() | Σ | 0..1 | Duration | How long it took to collect specimen | Σ | 0..1 | Duration | How long it took to collect specimen | |||||||||
![]() ![]() ![]() | 0..1 | ?? | The quantity of specimen collected | 0..1 | ?? | The quantity of specimen collected | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Technique used to perform collection Binding: ?? (preferred) | 0..1 | CodeableConcept | Technique used to perform collection Binding: ?? (example): The technique that is used to perform the procedure. |
| ||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Anatomical collection site Binding: ?? (preferred) | 0..1 | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen Source Site Binding: ?? (extensible) | |||||||||||
![]() ![]() ![]() | Σ | 0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink Binding: ?? (extensible): Codes describing the fasting status of the patient. | Σ | 0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink Binding: ?? (extensible): Codes describing the fasting status of the patient. | |||||||||
![]() ![]() | 0..* | BackboneElement | Processing and processing step details | 0..* | BackboneElement | Processing and processing step details | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | 0..1 | string | Textual description of procedure | 0..1 | string | Textual description of procedure | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ?? (example): Type indicating the technique used to process the specimen. | 0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: ?? (example): Type indicating the technique used to process the specimen. | |||||||||||
![]() ![]() ![]() | 0..* | Reference(Substance) | Material used in the processing step | 0..* | Reference(Substance) | Material used in the processing step | |||||||||||
![]() ![]() ![]() | 0..1 | dateTime, Period | Date and time of specimen processing | 0..1 | dateTime, Period | Date and time of specimen processing | |||||||||||
![]() ![]() | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | 0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||||||||
![]() ![]() ![]() | 0..1 | string | Unique id for inter-element referencing | 0..1 | string | Unique id for inter-element referencing | |||||||||||
![]() ![]() ![]() | 0..* | Extension | Additional content defined by implementations | 0..* | Extension | Additional content defined by implementations | |||||||||||
![]() ![]() ![]() | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | |||||||||
![]() ![]() ![]() | Σ | 0..* | Identifier | Id for the container | Σ | 0..* | Identifier | Id for the container | |||||||||
![]() ![]() ![]() | 0..1 | string | Textual description of the container | 0..1 | string | Textual description of the container | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ?? (example): Type of specimen container. | 0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: ?? (example): Type of specimen container. | |||||||||||
![]() ![]() ![]() | 0..1 | ?? | Container volume or size | 0..1 | ?? | Container volume or size | |||||||||||
![]() ![]() ![]() | 0..1 | ?? | Quantity of specimen within container | 0..1 | ?? | Quantity of specimen within container | |||||||||||
![]() ![]() ![]() | 0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Binding: ?? (example): Substance added to specimen container. | 0..1 | CodeableConcept, Reference(Substance) | Additive associated with container Binding: ?? (example): Substance added to specimen container. | |||||||||||
![]() ![]() | Σ | 0..* | CodeableConcept | State of the specimen Binding: ?? (extensible): Codes describing the state of the specimen. | Σ | 0..* | CodeableConcept | 𝗔𝗗𝗗𝗜𝗧𝗜𝗢𝗡𝗔𝗟 𝗨𝗦𝗖𝗗𝗜: Specimen condition Binding: ?? (extensible) | |||||||||
![]() ![]() | 0..* | Annotation | Comments | 0..* | Annotation | Comments | |||||||||||
Documentation for this format | |||||||||||||||||