Order Catalog Implementation Guide
0.1.0 - STU Ballot 1
Order Catalog Implementation Guide
0.1.0 - STU Ballot 1
This page is part of the Order Catalog Implementation Guide (v0.1.0: STU 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions 
The LabSpecimenDefinition profile constrains the SpecimenDefinition resource to represent definitions of IVD specimens attached to laboratory procedures described in catalogs of laboratory services using these procedures and specimens.
The official URL for this profile is:
http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabSpecimenDefinition
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from SpecimenDefinition
This structure is derived from SpecimenDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  SpecimenDefinition | 0..* | SpecimenDefinition | Kind of specimen | |
  typeTested | S | 0..* | BackboneElement | Specimen in container intended for testing by lab |
  type | S | 0..1 | CodeableConcept | Type of intended specimen |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SpecimenDefinition | I | 0..* | SpecimenDefinition | Kind of specimen |
  id | Σ | 0..1 | string | Logical id of this artifact |
 meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
 extension | I | 0..* | Extension | Additional content defined by implementations |
 modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Business identifier of a kind of specimen |
| typeCollected | ΣI | 0..1 | CodeableConcept | Kind of material to collect Binding: hl7VS-specimenType (example) |
| patientPreparation | ΣI | 0..* | CodeableConcept | Patient preparation for collection Binding: PreparePatient (example) |
| timeAspect | ΣI | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge |
| collection | ΣI | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example) |
| typeTested | SI | 0..* | BackboneElement | Specimen in container intended for testing by lab |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| isDerived | I | 0..1 | boolean | Primary or secondary specimen Example General: false |
| type | SI | 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (example) |
| preference | I | 1..1 | code | preferred | alternate Binding: SpecimenContainedPreference (required) Example General: preferred, alternate |
 container | I | 0..1 | BackboneElement | The specimen's container |
 id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| material | I | 0..1 | CodeableConcept | Container material Binding: ContainerMaterials (example) |
| type | I | 0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example) |
| cap | I | 0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example) |
| description | I | 0..1 | string | Container description Example General: Blue top tube with citrate |
| capacity | I | 0..1 | SimpleQuantity | Container capacity |
 minimumVolume[x] | I | 0..1 | Minimum volume | |
| minimumVolumeQuantity | Quantity(SimpleQuantity) | |||
| minimumVolumeString | string | |||
| additive | I | 0..* | BackboneElement | Additive associated with container |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| additive[x] | I | 1..1 | Additive associated with container Binding: hl7VS-additivePreservative (example) | |
| additiveCodeableConcept | CodeableConcept | |||
 additiveReference | Reference(Substance) | |||
| preparation | I | 0..1 | string | Specimen container preparation |
| requirement | I | 0..1 | string | Specimen requirements |
| retentionTime | I | 0..1 | Duration | Specimen retention time |
| rejectionCriterion | I | 0..* | CodeableConcept | Rejection criterion Binding: RejectionCriterion (example) |
| handling | I | 0..* | BackboneElement | Specimen handling before testing |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| temperatureQualifier | I | 0..1 | CodeableConcept | Temperature qualifier Binding: HandlingConditionSet (example) |
| temperatureRange | I | 0..1 | Range | Temperature range |
| maxDuration | I | 0..1 | Duration | Maximum preservation time |
| instruction | I | 0..1 | string | Preservation instruction Example General: freeze within 4 hours |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SpecimenDefinition | I | 0..* | SpecimenDefinition | Kind of specimen |
| typeTested | I | 0..* | BackboneElement | Specimen in container intended for testing by lab |
| type | I | 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (example) |
| Documentation for this format | ||||
This structure is derived from SpecimenDefinition
Differential View
This structure is derived from SpecimenDefinition
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SpecimenDefinition | 0..* | SpecimenDefinition | Kind of specimen | |
| typeTested | S | 0..* | BackboneElement | Specimen in container intended for testing by lab |
| type | S | 0..1 | CodeableConcept | Type of intended specimen |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| SpecimenDefinition | I | 0..* | SpecimenDefinition | Kind of specimen |
| id | Σ | 0..1 | string | Logical id of this artifact |
| meta | ΣI | 0..1 | Meta | Metadata about the resource |
| implicitRules | ?!ΣI | 0..1 | uri | A set of rules under which this content was created |
| language | I | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages |
| text | I | 0..1 | Narrative | Text summary of the resource, for human interpretation |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!I | 0..* | Extension | Extensions that cannot be ignored |
| identifier | ΣI | 0..1 | Identifier | Business identifier of a kind of specimen |
| typeCollected | ΣI | 0..1 | CodeableConcept | Kind of material to collect Binding: hl7VS-specimenType (example) |
| patientPreparation | ΣI | 0..* | CodeableConcept | Patient preparation for collection Binding: PreparePatient (example) |
| timeAspect | ΣI | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge |
| collection | ΣI | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example) |
| typeTested | SI | 0..* | BackboneElement | Specimen in container intended for testing by lab |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| isDerived | I | 0..1 | boolean | Primary or secondary specimen Example General: false |
| type | SI | 0..1 | CodeableConcept | Type of intended specimen Binding: hl7VS-specimenType (example) |
| preference | I | 1..1 | code | preferred | alternate Binding: SpecimenContainedPreference (required) Example General: preferred, alternate |
| container | I | 0..1 | BackboneElement | The specimen's container |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| material | I | 0..1 | CodeableConcept | Container material Binding: ContainerMaterials (example) |
| type | I | 0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example) |
| cap | I | 0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example) |
| description | I | 0..1 | string | Container description Example General: Blue top tube with citrate |
| capacity | I | 0..1 | SimpleQuantity | Container capacity |
| minimumVolume[x] | I | 0..1 | Minimum volume | |
| minimumVolumeQuantity | Quantity(SimpleQuantity) | |||
| minimumVolumeString | string | |||
| additive | I | 0..* | BackboneElement | Additive associated with container |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| additive[x] | I | 1..1 | Additive associated with container Binding: hl7VS-additivePreservative (example) | |
| additiveCodeableConcept | CodeableConcept | |||
| additiveReference | Reference(Substance) | |||
| preparation | I | 0..1 | string | Specimen container preparation |
| requirement | I | 0..1 | string | Specimen requirements |
| retentionTime | I | 0..1 | Duration | Specimen retention time |
| rejectionCriterion | I | 0..* | CodeableConcept | Rejection criterion Binding: RejectionCriterion (example) |
| handling | I | 0..* | BackboneElement | Specimen handling before testing |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | I | 0..* | Extension | Additional content defined by implementations |
| modifierExtension | ?!ΣI | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| temperatureQualifier | I | 0..1 | CodeableConcept | Temperature qualifier Binding: HandlingConditionSet (example) |
| temperatureRange | I | 0..1 | Range | Temperature range |
| maxDuration | I | 0..1 | Duration | Maximum preservation time |
| instruction | I | 0..1 | string | Preservation instruction Example General: freeze within 4 hours |
| Documentation for this format | ||||
Other representations of profile: Schematron
| Path | Conformance | ValueSet |
| SpecimenDefinition.language | preferred | CommonLanguages Max Binding: AllLanguages |
| SpecimenDefinition.typeCollected | example | Hl7VSSpecimenType |
| SpecimenDefinition.patientPreparation | example | PreparePatient |
| SpecimenDefinition.collection | example | SpecimenCollection |
| SpecimenDefinition.typeTested.type | example | Hl7VSSpecimenType |
| SpecimenDefinition.typeTested.preference | required | SpecimenContainedPreference |
| SpecimenDefinition.typeTested.container.material | example | ContainerMaterials |
| SpecimenDefinition.typeTested.container.type | example | SpecimenContainerType |
| SpecimenDefinition.typeTested.container.cap | example | ContainerCap |
| SpecimenDefinition.typeTested.container.additive.additive[x] | example | Hl7VSAdditivePreservative |
| SpecimenDefinition.typeTested.rejectionCriterion | example | RejectionCriterion |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | example | HandlingConditionSet |
| Id | Path | Details | Requirements |
| dom-2 | SpecimenDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-3 | SpecimenDefinition | 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-4 | SpecimenDefinition | 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-5 | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| dom-6 | SpecimenDefinition | A resource should have narrative for robust management : text.`div`.exists() | |
| ele-1 | SpecimenDefinition.meta | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.implicitRules | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.language | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.text | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.identifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeCollected | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.patientPreparation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.timeAspect | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.collection | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.isDerived | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.preference | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.container.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.container.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.container.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.container.material | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.type | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.cap | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.description | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.capacity | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.minimumVolume[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.additive | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.additive.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.container.additive.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.container.additive.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.container.additive.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.container.additive.additive[x] | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.container.preparation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.requirement | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.retentionTime | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.rejectionCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.handling | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.handling.extension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.handling.extension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.handling.modifierExtension | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | SpecimenDefinition.typeTested.handling.modifierExtension | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
| ele-1 | SpecimenDefinition.typeTested.handling.temperatureQualifier | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.handling.temperatureRange | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.handling.maxDuration | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ele-1 | SpecimenDefinition.typeTested.handling.instruction | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
IG © 2020+ HL7 International - Orders and Observations Work Group. Package hl7.fhir.uv.order-catalog#0.1.0 based on FHIR 4.0.1. Generated 2020-08-09
Links: Table of Contents |
QA Report | Search
| Version History |
|
Propose a change