International Patient Summary Implementation Guide
2.0.1 - STU 2
International Patient Summary Implementation Guide
2.0.1 - STU 2
International Patient Summary Implementation Guide, published by HL7 International / Patient Care. This guide is not an authorized publication; it is the continuous build for version 2.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-ips/ and changes regularly. See the Directory of published versions
| Official URL: http://hl7.org/fhir/uv/ips/StructureDefinition/Specimen-uv-ips | Version: 2.0.1 | ||||
| Standards status: Trial-use | Maturity Level: 3 | Computable Name: SpecimenUvIps | |||
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.
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
  Specimen |
0..* | Specimen(4.0.1) | Sample for analysis | |||||||||
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
 modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
 type |
SOΣ | 1..1 | CodeableConceptIPS(2.0.1) | Kind of material that forms the specimen Binding: ResultsSpecimenTypeUvIps (2.0.1) (preferred)
| ||||||||
  subject |
SOΣ | 0..1 | Reference(Patient (IPS)(2.0.1)) | 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
| ||||||||
  reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
| reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | error | Specimen | 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 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Specimen.implicitRules, Specimen.modifierExtension, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
 reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Specimen.collection.method | Base | preferred | Results Specimen Collection Method - IPS | 📍2.0.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Body Site - IPS | 📍2.0.1 | This IG |
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen(4.0.1) | Sample for analysis | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
 extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||||||
| identifier |
Σ | 0..* | Identifier | External Identifier | ||||||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
| type |
SOΣ | 1..1 | CodeableConceptIPS(2.0.1) | Kind of material that forms the specimen Binding: ResultsSpecimenTypeUvIps (2.0.1) (preferred)
| ||||||||
 subject |
SOΣ | 0..1 | Reference(Patient (IPS)(2.0.1)) | 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
| ||||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| receivedTime |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||
| request |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||||||
| collection |
0..1 | BackboneElement | Collection details | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| collector |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||||||
 collected[x] |
Σ | 0..1 | Collection time | |||||||||
| collectedDateTime |
dateTime | |||||||||||
| collectedPeriod |
Period | |||||||||||
| duration |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | |||||||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: ResultsSpecimenCollectionMethodUvIps (2.0.1) (preferred) | |||||||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: BodySiteUvIps (2.0.1) (preferred) | |||||||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9)  (extensible): Codes describing the fasting status of the patient. | |||||||||
| fastingStatusCodeableConcept |
CodeableConcept | |||||||||||
| fastingStatusDuration |
Duration | |||||||||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| description |
0..1 | string | Textual description of procedure | |||||||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||||||
| timeDateTime |
dateTime | |||||||||||
| timePeriod |
Period | |||||||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| identifier |
Σ | 0..* | Identifier | Id for the container | ||||||||
| description |
0..1 | string | Textual description of the container | |||||||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||||||
| capacity |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||
| specimenQuantity |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||
| additive[x] |
0..1 | Additive associated with container Binding: v2.0371 (2.9) (example): Substance added to specimen container. | ||||||||||
| additiveCodeableConcept |
CodeableConcept | |||||||||||
| additiveReference |
Reference(Substance) | |||||||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) (extensible): Codes describing the state of the specimen. | ||||||||
| note |
0..* | Annotation | Comments | |||||||||
| Documentation for this format | ||||||||||||
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
| reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Specimen.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Specimen.collection.method | Base | preferred | Results Specimen Collection Method - IPS | 📍2.0.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Body Site - IPS | 📍2.0.1 | This IG |
| Specimen.collection.fastingStatus[x] | Base | extensible |
v2 Relevant Clincial Information
|
📍2.9 | tx.fhir.org |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example |
v2 Additive
|
📍2.9 | tx.fhir.org |
| Specimen.condition | Base | extensible |
v2 Specimen Condition
|
📍2.9 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | error | Specimen | 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 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.extension, Specimen.subject.reference, Specimen.subject.type, Specimen.subject.identifier, Specimen.subject.display, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.modifierExtension, Specimen.subject.extension, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen(4.0.1) | Sample for analysis | |||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
| type |
SOΣ | 1..1 | CodeableConceptIPS(2.0.1) | Kind of material that forms the specimen Binding: ResultsSpecimenTypeUvIps (2.0.1) (preferred)
| ||||||||
| subject |
SOΣ | 0..1 | Reference(Patient (IPS)(2.0.1)) | 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
| ||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| Documentation for this format | ||||||||||||
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
| reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | error | Specimen | 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 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Specimen.implicitRules, Specimen.modifierExtension, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.reference | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Specimen |
Specimen(4.0.1) | |||||||||||
| type |
SO | 1..1 | CodeableConceptIPS(2.0.1) | Kind of material that forms the specimen Binding: ResultsSpecimenTypeUvIps (2.0.1) (preferred)
| ||||||||
| subject |
SO | 0..1 | Reference(Patient (IPS)(2.0.1)) | 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
| ||||||||
| reference |
SO | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| collection |
||||||||||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: ResultsSpecimenCollectionMethodUvIps (2.0.1) (preferred) | |||||||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: BodySiteUvIps (2.0.1) (preferred) | |||||||||
| Documentation for this format | ||||||||||||
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
| reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Specimen.collection.method | Base | preferred | Results Specimen Collection Method - IPS | 📍2.0.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Body Site - IPS | 📍2.0.1 | This IG |
Snapshot ViewView
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen(4.0.1) | Sample for analysis | |||||||||
| id |
Σ | 0..1 | id | Logical id of this artifact | ||||||||
| meta |
Σ | 0..1 | Meta | Metadata about the resource | ||||||||
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||||||
| language |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||||||
| text |
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 | |||||||||
| contained |
0..* | Resource | Contained, inline Resources | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 | ||||||||
| identifier |
Σ | 0..* | Identifier | External Identifier | ||||||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||||||
| type |
SOΣ | 1..1 | CodeableConceptIPS(2.0.1) | Kind of material that forms the specimen Binding: ResultsSpecimenTypeUvIps (2.0.1) (preferred)
| ||||||||
| subject |
SOΣ | 0..1 | Reference(Patient (IPS)(2.0.1)) | 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
| ||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||
| reference |
SOΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL
| ||||||||
| type |
Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model). | ||||||||
| identifier |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||||||
| display |
Σ | 0..1 | string | Text alternative for the resource | ||||||||
| receivedTime |
Σ | 0..1 | dateTime | The time when specimen was received for processing | ||||||||
| parent |
0..* | Reference(Specimen) | Specimen from which this specimen originated | |||||||||
| request |
0..* | Reference(ServiceRequest) | Why the specimen was collected | |||||||||
| collection |
0..1 | BackboneElement | Collection details | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| collector |
Σ | 0..1 | Reference(Practitioner | PractitionerRole) | Who collected the specimen | ||||||||
| collected[x] |
Σ | 0..1 | Collection time | |||||||||
| collectedDateTime |
dateTime | |||||||||||
| collectedPeriod |
Period | |||||||||||
| duration |
Σ | 0..1 | Duration | How long it took to collect specimen | ||||||||
| quantity |
0..1 | SimpleQuantity(4.0.1) | The quantity of specimen collected | |||||||||
| method |
0..1 | CodeableConcept | Technique used to perform collection Binding: ResultsSpecimenCollectionMethodUvIps (2.0.1) (preferred) | |||||||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: BodySiteUvIps (2.0.1) (preferred) | |||||||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: v2.0916 (2.9) (extensible): Codes describing the fasting status of the patient. | |||||||||
| fastingStatusCodeableConcept |
CodeableConcept | |||||||||||
| fastingStatusDuration |
Duration | |||||||||||
| processing |
0..* | BackboneElement | Processing and processing step details | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| description |
0..1 | string | Textual description of procedure | |||||||||
| procedure |
0..1 | CodeableConcept | Indicates the treatment step applied to the specimen Binding: SpecimenProcessingProcedure (example): Type indicating the technique used to process the specimen. | |||||||||
| additive |
0..* | Reference(Substance) | Material used in the processing step | |||||||||
| time[x] |
0..1 | Date and time of specimen processing | ||||||||||
| timeDateTime |
dateTime | |||||||||||
| timePeriod |
Period | |||||||||||
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |||||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||||||
| extension |
0..* | Extension | Additional content defined by implementations Constraints: ext-1 | |||||||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized Constraints: ext-1 | ||||||||
| identifier |
Σ | 0..* | Identifier | Id for the container | ||||||||
| description |
0..1 | string | Textual description of the container | |||||||||
| type |
0..1 | CodeableConcept | Kind of container directly associated with specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||||||
| capacity |
0..1 | SimpleQuantity(4.0.1) | Container volume or size | |||||||||
| specimenQuantity |
0..1 | SimpleQuantity(4.0.1) | Quantity of specimen within container | |||||||||
| additive[x] |
0..1 | Additive associated with container Binding: v2.0371 (2.9) (example): Substance added to specimen container. | ||||||||||
| additiveCodeableConcept |
CodeableConcept | |||||||||||
| additiveReference |
Reference(Substance) | |||||||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: v2.0493 (2.9) (extensible): Codes describing the state of the specimen. | ||||||||
| note |
0..* | Annotation | Comments | |||||||||
| Documentation for this format | ||||||||||||
| Name | Consumer (IPS) | Creator (IPS) |
|---|---|---|
| Specimen |
||
| type |
| |
| subject |
| |
| reference |
|
|
| Documentation for this format | ||
| Path | Status | Usage | ValueSet | Version | Source |
| Specimen.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std. |
| Specimen.status | Base | required | SpecimenStatus | 📍4.0.1 | FHIR Std. |
| Specimen.type | Base | preferred | Results Specimen Type - IPS | 📍2.0.1 | This IG |
| Specimen.subject.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std. |
| Specimen.collection.method | Base | preferred | Results Specimen Collection Method - IPS | 📍2.0.1 | This IG |
| Specimen.collection.bodySite | Base | preferred | Body Site - IPS | 📍2.0.1 | This IG |
| Specimen.collection.fastingStatus[x] | Base | extensible |
v2 Relevant Clincial Information
|
📍2.9 | tx.fhir.org |
| Specimen.processing.procedure | Base | example | Specimen processing procedure | 📍4.0.1 | FHIR Std. |
| Specimen.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| Specimen.container.additive[x] | Base | example |
v2 Additive
|
📍2.9 | tx.fhir.org |
| Specimen.condition | Base | extensible |
v2 Specimen Condition
|
📍2.9 | tx.fhir.org |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | Specimen | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | Specimen | 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 | error | Specimen | 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 | error | Specimen | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | Specimen | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | Specimen.meta, Specimen.implicitRules, Specimen.language, Specimen.text, Specimen.extension, Specimen.modifierExtension, Specimen.identifier, Specimen.accessionIdentifier, Specimen.status, Specimen.type, Specimen.subject, Specimen.subject.extension, Specimen.subject.reference, Specimen.subject.type, Specimen.subject.identifier, Specimen.subject.display, Specimen.receivedTime, Specimen.parent, Specimen.request, Specimen.collection, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.collection.collector, Specimen.collection.collected[x], Specimen.collection.duration, Specimen.collection.quantity, Specimen.collection.method, Specimen.collection.bodySite, Specimen.collection.fastingStatus[x], Specimen.processing, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.processing.description, Specimen.processing.procedure, Specimen.processing.additive, Specimen.processing.time[x], Specimen.container, Specimen.container.extension, Specimen.container.modifierExtension, Specimen.container.identifier, Specimen.container.description, Specimen.container.type, Specimen.container.capacity, Specimen.container.specimenQuantity, Specimen.container.additive[x], Specimen.condition, Specimen.note | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | Specimen.extension, Specimen.modifierExtension, Specimen.subject.extension, Specimen.collection.extension, Specimen.collection.modifierExtension, Specimen.processing.extension, Specimen.processing.modifierExtension, Specimen.container.extension, Specimen.container.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Summary
Mandatory: 1 element(1 nested mandatory element)
Must-Support: 3 elements
Structures
This structure refers to these other structures:
Maturity: 3
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care.
Package hl7.fhir.uv.ips#2.0.1 based on FHIR 4.0.1.
Generated
2026-06-04
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change