International Patient Summary Implementation Guide
1.1.0 - CI Build
International Patient Summary Implementation Guide
1.1.0 - CI Build
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 1.1.0 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: 1.1.0 | |||
| Standards status: Trial-use | Maturity Level: 2 | 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.
Minimal specimen attributes, usable for the laboratory results section and entry of a patient summary.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
  Specimen |
0..* | Specimen | Sample for analysis | |||||
  type |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
  subject |
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 | |||||
   reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |||||
 collection |
0..1 | BackboneElement | Collection details | |||||
 method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
 fastingStatus[x] |
0..1 | Whether or how long patient abstained from food and/or drink | ||||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| fastingStatusDuration |
Duration | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | 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 | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
| subject |
Σ | 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 | ||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| fastingStatusDuration |
Duration | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG | ||||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
 extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
| subject |
Σ | 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
Σ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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | The quantity of specimen collected | |||||
| method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | Container volume or size | |||||
| specimenQuantity |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG | ||||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedurefrom the FHIR Standard | ||||||
| Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-typefrom the FHIR Standard | ||||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||||
| Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 1 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 2
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | Sample for analysis | |||||
| type |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
| subject |
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 | |||||
| reference |
1..1 | string | Literal reference, Relative, internal or absolute URL | |||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
| fastingStatus[x] |
0..1 | Whether or how long patient abstained from food and/or drink | ||||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| fastingStatusDuration |
Duration | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | 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 | ||||
| status |
?!Σ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
| subject |
Σ | 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 | ||||
| reference |
ΣC | 1..1 | string | Literal reference, Relative, internal or absolute URL | ||||
| collection |
0..1 | BackboneElement | Collection details | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| fastingStatusDuration |
Duration | |||||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG | ||||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints | ||||
|---|---|---|---|---|---|---|---|---|
| Specimen |
0..* | Specimen | 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 | |||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| 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 |
1..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Results Specimen Type - IPS (preferred)
| |||||
| subject |
Σ | 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 | ||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| reference |
Σ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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | The quantity of specimen collected | |||||
| method |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: FHIRSpecimenCollectionMethod (preferred) | |||||
| bodySite |
0..1 | CodeableConceptIPS | Concept - reference to a terminology or just text Binding: Body Site - IPS (preferred) | |||||
| fastingStatus[x] |
Σ | 0..1 | Whether or how long patient abstained from food and/or drink Binding: hl7VS-relevantClincialInformation (extensible): Codes describing the fasting status of the patient. | |||||
| fastingStatusCodeableConcept |
CodeableConcept(CodeableConceptIPS) | |||||||
| 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | |||||
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
| 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 | Container volume or size | |||||
| specimenQuantity |
0..1 | SimpleQuantity | Quantity of specimen within container | |||||
| additive[x] |
0..1 | Additive associated with container Binding: hl7VS-additivePreservative (example): Substance added to specimen container. | ||||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| condition |
Σ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note |
0..* | Annotation | Comments | |||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet | URI | |||||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||||
| Specimen.type | preferred | ResultsSpecimenTypeUvIps
http://hl7.org/fhir/uv/ips/ValueSet/results-specimen-type-uv-ipsfrom this IG | ||||||
| Specimen.subject.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-typesfrom the FHIR Standard | ||||||
| Specimen.collection.method | preferred | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||||
| Specimen.collection.bodySite | preferred | BodySiteUvIpshttp://hl7.org/fhir/uv/ips/ValueSet/body-site-uv-ipsfrom this IG | ||||||
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | ||||||
| Specimen.processing.procedure | example | SpecimenProcessingProcedurehttp://hl7.org/fhir/ValueSet/specimen-processing-procedurefrom the FHIR Standard | ||||||
| Specimen.container.type | example | SpecimenContainerTypehttp://hl7.org/fhir/ValueSet/specimen-container-typefrom the FHIR Standard | ||||||
| Specimen.container.additive[x] | example | Hl7VSAdditivePreservativehttp://terminology.hl7.org/ValueSet/v2-0371 | ||||||
| Specimen.condition | extensible | Hl7VSSpecimenConditionhttp://terminology.hl7.org/ValueSet/v2-0493 |
| Id | Grade | Path(s) | Details | Requirements |
| 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 | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Specimen
Summary
Mandatory: 1 element(1 nested mandatory element)
Structures
This structure refers to these other structures:
Maturity: 2
Other representations of profile: CSV, Excel, Schematron
IG © 2020+ HL7 International / Patient Care. Package hl7.fhir.uv.ips#1.1.0 based on FHIR 4.0.1. Generated 2024-05-19
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change