Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR R5
0.1.0 - STU
Extensions for Using Data Elements from FHIR R4 in FHIR R5 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/4.0/StructureDefinition/profile-SpecimenDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R4_SpecimenDefinition_R5 | ||
This cross-version profile allows R4 SpecimenDefinition content to be represented via FHIR R5 SpecimenDefinition resources.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |
  implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
 status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | SpecimenDefinition.implicitRules, SpecimenDefinition.modifierExtension, SpecimenDefinition.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SpecimenDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |
  typeTested |
||||
 container |
||||
| additive |
||||
| additiveReference |
||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
  extension:alternateReference |
0..1 | Reference(Resource) | R4: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |||||
| 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: AllLanguages (required): IETF language tag for 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 | ||||
| url |
Σ | 0..1 | uri | Logical canonical URL to reference this SpecimenDefinition (globally unique) | ||||
| identifier |
Σ | 0..1 | Identifier | Business identifier | ||||
| version |
Σ | 0..1 | string | Business version of the SpecimenDefinition | ||||
  versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
 versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
Σ | 0..1 | string | Name for this {{title}} (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this SpecimenDefinition (Human friendly) | ||||
| derivedFromCanonical |
Σ | 0..* | canonical(SpecimenDefinition) | Based on FHIR definition of another SpecimenDefinition | ||||
| derivedFromUri |
Σ | 0..* | uri | Based on external definition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource. | ||||
| experimental |
Σ | 0..1 | boolean | If this SpecimenDefinition is not for real usage | ||||
| subject[x] |
Σ | 0..1 | Type of subject for specimen collection | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
 subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date status first applied | ||||
| publisher |
Σ | 0..1 | string | The name of the individual or organization that published the SpecimenDefinition | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the SpecimenDefinition | |||||
| useContext |
0..* | UsageContext | Content intends to support these contexts | |||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for this SpecimenDefinition (if applicable) Binding: JurisdictionValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | ||||
| purpose |
0..1 | markdown | Why this SpecimenDefinition is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| approvalDate |
0..1 | date | When SpecimenDefinition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | The date on which the asset content was last reviewed by the publisher | |||||
| effectivePeriod |
Σ | 0..1 | Period | The effective date range for the SpecimenDefinition | ||||
| typeCollected |
Σ | 0..1 | CodeableConcept | Kind of material to collect Binding: Hl7VSSpecimenType (3.0.0) (example): The type of the specimen to be collected. | ||||
| patientPreparation |
Σ | 0..* | CodeableConcept | Patient preparation for collection Binding: PreparePatient (example): SCT descendants of 703763000 |Precondition value (qualifier value)| | ||||
| timeAspect |
Σ | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge | ||||
| collection |
Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example): SCT actions and procedures for specimen collection | ||||
| typeTested |
0..* | BackboneElement | Specimen in container intended for testing by lab | |||||
| 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 | ||||
| isDerived |
0..1 | boolean | Primary or secondary specimen Example General: false | |||||
| type |
0..1 | CodeableConcept | Type of intended specimen Binding: Hl7VSSpecimenType (3.0.0) (example): The type of specimen conditioned in a container for lab testing. | |||||
| preference |
1..1 | code | preferred | alternate Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen. Example General: preferred, alternate | |||||
| container |
0..1 | BackboneElement | The specimen's container | |||||
| 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 | ||||
| material |
0..1 | CodeableConcept | The material type used for the container Binding: ContainerMaterials (example): SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal| | |||||
| type |
0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example): SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)| | |||||
| cap |
0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example): Color of the container cap. | |||||
| description |
0..1 | markdown | The description of the kind of container Example General: Blue top tube with citrate | |||||
| capacity |
0..1 | SimpleQuantity(5.0.0) | The capacity of this kind of container | |||||
| minimumVolume[x] |
0..1 | Minimum volume | ||||||
| minimumVolumeQuantity |
Quantity(SimpleQuantity) | |||||||
| minimumVolumeString |
string | |||||||
| additive |
0..* | BackboneElement | Additive associated with container | |||||
| 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 | ||||
| additive[x] |
1..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
| additive[x]All Types |
Content/Rules for all Types | |||||||
 id |
0..1 | string | Unique id for inter-element referencing | |||||
 Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | R4: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(SubstanceDefinition) | |||||||
| preparation |
0..1 | markdown | Special processing applied to the container for this specimen type | |||||
| requirement |
0..1 | markdown | Requirements for specimen delivery and special handling | |||||
| retentionTime |
0..1 | Duration | The usual time for retaining this kind of specimen | |||||
| singleUse |
0..1 | boolean | Specimen for single use only | |||||
| rejectionCriterion |
0..* | CodeableConcept | Criterion specified for specimen rejection Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory. | |||||
| handling |
0..* | BackboneElement | Specimen handling before testing | |||||
| 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 | ||||
| temperatureQualifier |
0..1 | CodeableConcept | Qualifies the interval of temperature Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen. | |||||
| temperatureRange |
0..1 | Range | Temperature range for these handling instructions | |||||
| maxDuration |
0..1 | Duration | Maximum preservation time | |||||
| instruction |
0..1 | markdown | Preservation instruction Example General: freeze within 4 hours | |||||
| testingDestination |
0..* | CodeableConcept | Where the specimen will be tested Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeCollected | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.patientPreparation | Base | example | Patient preparation prior specimen collection | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.collection | Base | example | Specimen collection methods | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.preference | Base | required | Specimen Contained Preference | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.material | Base | example | Types of material for specimen containers | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.type | Base | example | Specimen Container Type | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.cap | Base | example | Container Cap | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.additive.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.rejectionCriterion | Base | example | Rejection Criterion | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | Base | example | Handling Condition Set | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.testingDestination | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | SpecimenDefinition.meta, SpecimenDefinition.implicitRules, SpecimenDefinition.language, SpecimenDefinition.text, SpecimenDefinition.extension, SpecimenDefinition.modifierExtension, SpecimenDefinition.url, SpecimenDefinition.identifier, SpecimenDefinition.version, SpecimenDefinition.versionAlgorithm[x], SpecimenDefinition.name, SpecimenDefinition.title, SpecimenDefinition.derivedFromCanonical, SpecimenDefinition.derivedFromUri, SpecimenDefinition.status, SpecimenDefinition.experimental, SpecimenDefinition.subject[x], SpecimenDefinition.date, SpecimenDefinition.publisher, SpecimenDefinition.contact, SpecimenDefinition.description, SpecimenDefinition.useContext, SpecimenDefinition.jurisdiction, SpecimenDefinition.purpose, SpecimenDefinition.copyright, SpecimenDefinition.copyrightLabel, SpecimenDefinition.approvalDate, SpecimenDefinition.lastReviewDate, SpecimenDefinition.effectivePeriod, SpecimenDefinition.typeCollected, SpecimenDefinition.patientPreparation, SpecimenDefinition.timeAspect, SpecimenDefinition.collection, SpecimenDefinition.typeTested, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.modifierExtension, SpecimenDefinition.typeTested.isDerived, SpecimenDefinition.typeTested.type, SpecimenDefinition.typeTested.preference, SpecimenDefinition.typeTested.container, SpecimenDefinition.typeTested.container.extension, SpecimenDefinition.typeTested.container.modifierExtension, SpecimenDefinition.typeTested.container.material, SpecimenDefinition.typeTested.container.type, SpecimenDefinition.typeTested.container.cap, SpecimenDefinition.typeTested.container.description, SpecimenDefinition.typeTested.container.capacity, SpecimenDefinition.typeTested.container.minimumVolume[x], SpecimenDefinition.typeTested.container.additive, SpecimenDefinition.typeTested.container.additive.extension, SpecimenDefinition.typeTested.container.additive.modifierExtension, SpecimenDefinition.typeTested.container.additive.additive[x], SpecimenDefinition.typeTested.container.additive.additive[x].extension, SpecimenDefinition.typeTested.container.additive.additive[x].extension:alternateReference, SpecimenDefinition.typeTested.container.preparation, SpecimenDefinition.typeTested.requirement, SpecimenDefinition.typeTested.retentionTime, SpecimenDefinition.typeTested.singleUse, SpecimenDefinition.typeTested.rejectionCriterion, SpecimenDefinition.typeTested.handling, SpecimenDefinition.typeTested.handling.extension, SpecimenDefinition.typeTested.handling.modifierExtension, SpecimenDefinition.typeTested.handling.temperatureQualifier, SpecimenDefinition.typeTested.handling.temperatureRange, SpecimenDefinition.typeTested.handling.maxDuration, SpecimenDefinition.typeTested.handling.instruction, SpecimenDefinition.typeTested.testingDestination | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.modifierExtension, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.modifierExtension, SpecimenDefinition.typeTested.container.extension, SpecimenDefinition.typeTested.container.modifierExtension, SpecimenDefinition.typeTested.container.additive.extension, SpecimenDefinition.typeTested.container.additive.modifierExtension, SpecimenDefinition.typeTested.container.additive.additive[x].extension, SpecimenDefinition.typeTested.container.additive.additive[x].extension:alternateReference, SpecimenDefinition.typeTested.handling.extension, SpecimenDefinition.typeTested.handling.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SpecimenDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |
| implicitRules |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
| contained |
0..* | Resource | Contained, inline Resources | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored Constraints: ext-1 |
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource. |
| Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | SpecimenDefinition.implicitRules, SpecimenDefinition.modifierExtension, SpecimenDefinition.status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from SpecimenDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |
| typeTested |
||||
| container |
||||
| additive |
||||
| additiveReference |
||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| extension:alternateReference |
0..1 | Reference(Resource) | R4: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference | |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(5.0.0) | Kind of specimen | |||||
| 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: AllLanguages (required): IETF language tag for 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 | ||||
| url |
Σ | 0..1 | uri | Logical canonical URL to reference this SpecimenDefinition (globally unique) | ||||
| identifier |
Σ | 0..1 | Identifier | Business identifier | ||||
| version |
Σ | 0..1 | string | Business version of the SpecimenDefinition | ||||
| versionAlgorithm[x] |
Σ | 0..1 | How to compare versions Binding: VersionAlgorithm (extensible) | |||||
| versionAlgorithmString |
string | |||||||
| versionAlgorithmCoding |
Coding | |||||||
| name |
Σ | 0..1 | string | Name for this {{title}} (computer friendly) | ||||
| title |
Σ | 0..1 | string | Name for this SpecimenDefinition (Human friendly) | ||||
| derivedFromCanonical |
Σ | 0..* | canonical(SpecimenDefinition) | Based on FHIR definition of another SpecimenDefinition | ||||
| derivedFromUri |
Σ | 0..* | uri | Based on external definition | ||||
| status |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): Codes identifying the status of a SpecimenDefinition resource. | ||||
| experimental |
Σ | 0..1 | boolean | If this SpecimenDefinition is not for real usage | ||||
| subject[x] |
Σ | 0..1 | Type of subject for specimen collection | |||||
| subjectCodeableConcept |
CodeableConcept | |||||||
| subjectReference |
Reference(Group) | |||||||
| date |
Σ | 0..1 | dateTime | Date status first applied | ||||
| publisher |
Σ | 0..1 | string | The name of the individual or organization that published the SpecimenDefinition | ||||
| contact |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
| description |
0..1 | markdown | Natural language description of the SpecimenDefinition | |||||
| useContext |
0..* | UsageContext | Content intends to support these contexts | |||||
| jurisdiction |
Σ | 0..* | CodeableConcept | Intended jurisdiction for this SpecimenDefinition (if applicable) Binding: JurisdictionValueSet (extensible): Codes for country, country subdivision and region for indicating where a resource is intended to be used. | ||||
| purpose |
0..1 | markdown | Why this SpecimenDefinition is defined | |||||
| copyright |
0..1 | markdown | Use and/or publishing restrictions | |||||
| copyrightLabel |
0..1 | string | Copyright holder and year(s) | |||||
| approvalDate |
0..1 | date | When SpecimenDefinition was approved by publisher | |||||
| lastReviewDate |
0..1 | date | The date on which the asset content was last reviewed by the publisher | |||||
| effectivePeriod |
Σ | 0..1 | Period | The effective date range for the SpecimenDefinition | ||||
| typeCollected |
Σ | 0..1 | CodeableConcept | Kind of material to collect Binding: Hl7VSSpecimenType (3.0.0) (example): The type of the specimen to be collected. | ||||
| patientPreparation |
Σ | 0..* | CodeableConcept | Patient preparation for collection Binding: PreparePatient (example): SCT descendants of 703763000 |Precondition value (qualifier value)| | ||||
| timeAspect |
Σ | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge | ||||
| collection |
Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example): SCT actions and procedures for specimen collection | ||||
| typeTested |
0..* | BackboneElement | Specimen in container intended for testing by lab | |||||
| 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 | ||||
| isDerived |
0..1 | boolean | Primary or secondary specimen Example General: false | |||||
| type |
0..1 | CodeableConcept | Type of intended specimen Binding: Hl7VSSpecimenType (3.0.0) (example): The type of specimen conditioned in a container for lab testing. | |||||
| preference |
1..1 | code | preferred | alternate Binding: SpecimenContainedPreference (required): Degree of preference of a type of conditioned specimen. Example General: preferred, alternate | |||||
| container |
0..1 | BackboneElement | The specimen's container | |||||
| 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 | ||||
| material |
0..1 | CodeableConcept | The material type used for the container Binding: ContainerMaterials (example): SCT 32039001 |Glass|, 61088005 |Plastic|, 425620007 |Metal| | |||||
| type |
0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example): SCT descendants of 706041008 |Device for body fluid and tissue collection/transfer/processing (physical object)| | |||||
| cap |
0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example): Color of the container cap. | |||||
| description |
0..1 | markdown | The description of the kind of container Example General: Blue top tube with citrate | |||||
| capacity |
0..1 | SimpleQuantity(5.0.0) | The capacity of this kind of container | |||||
| minimumVolume[x] |
0..1 | Minimum volume | ||||||
| minimumVolumeQuantity |
Quantity(SimpleQuantity) | |||||||
| minimumVolumeString |
string | |||||||
| additive |
0..* | BackboneElement | Additive associated with container | |||||
| 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 | ||||
| additive[x] |
1..1 | Additive associated with container Binding: Hl7VSAdditivePreservative (3.0.0) (example): Substance added to specimen container. | ||||||
| additive[x]All Types |
Content/Rules for all Types | |||||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:alternateReference |
0..1 | Reference(Resource) | R4: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(SubstanceDefinition) | |||||||
| preparation |
0..1 | markdown | Special processing applied to the container for this specimen type | |||||
| requirement |
0..1 | markdown | Requirements for specimen delivery and special handling | |||||
| retentionTime |
0..1 | Duration | The usual time for retaining this kind of specimen | |||||
| singleUse |
0..1 | boolean | Specimen for single use only | |||||
| rejectionCriterion |
0..* | CodeableConcept | Criterion specified for specimen rejection Binding: RejectionCriterion (example): Criterion for rejection of the specimen by laboratory. | |||||
| handling |
0..* | BackboneElement | Specimen handling before testing | |||||
| 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 | ||||
| temperatureQualifier |
0..1 | CodeableConcept | Qualifies the interval of temperature Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen. | |||||
| temperatureRange |
0..1 | Range | Temperature range for these handling instructions | |||||
| maxDuration |
0..1 | Duration | Maximum preservation time | |||||
| instruction |
0..1 | markdown | Preservation instruction Example General: freeze within 4 hours | |||||
| testingDestination |
0..* | CodeableConcept | Where the specimen will be tested Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested. | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.language | Base | required | All Languages | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.versionAlgorithm[x] | Base | extensible | Version Algorithm | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.status | Base | required | PublicationStatus | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.jurisdiction | Base | extensible | Jurisdiction ValueSet | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeCollected | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.patientPreparation | Base | example | Patient preparation prior specimen collection | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.collection | Base | example | Specimen collection methods | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.preference | Base | required | Specimen Contained Preference | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.material | Base | example | Types of material for specimen containers | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.type | Base | example | Specimen Container Type | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.cap | Base | example | Container Cap | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.container.additive.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.rejectionCriterion | Base | example | Rejection Criterion | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | Base | example | Handling Condition Set | 📍5.0.0 | FHIR Std. |
| SpecimenDefinition.typeTested.testingDestination | Base | example | Diagnostic Service Section Codes | 📍5.0.0 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| ele-1 | error | SpecimenDefinition.meta, SpecimenDefinition.implicitRules, SpecimenDefinition.language, SpecimenDefinition.text, SpecimenDefinition.extension, SpecimenDefinition.modifierExtension, SpecimenDefinition.url, SpecimenDefinition.identifier, SpecimenDefinition.version, SpecimenDefinition.versionAlgorithm[x], SpecimenDefinition.name, SpecimenDefinition.title, SpecimenDefinition.derivedFromCanonical, SpecimenDefinition.derivedFromUri, SpecimenDefinition.status, SpecimenDefinition.experimental, SpecimenDefinition.subject[x], SpecimenDefinition.date, SpecimenDefinition.publisher, SpecimenDefinition.contact, SpecimenDefinition.description, SpecimenDefinition.useContext, SpecimenDefinition.jurisdiction, SpecimenDefinition.purpose, SpecimenDefinition.copyright, SpecimenDefinition.copyrightLabel, SpecimenDefinition.approvalDate, SpecimenDefinition.lastReviewDate, SpecimenDefinition.effectivePeriod, SpecimenDefinition.typeCollected, SpecimenDefinition.patientPreparation, SpecimenDefinition.timeAspect, SpecimenDefinition.collection, SpecimenDefinition.typeTested, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.modifierExtension, SpecimenDefinition.typeTested.isDerived, SpecimenDefinition.typeTested.type, SpecimenDefinition.typeTested.preference, SpecimenDefinition.typeTested.container, SpecimenDefinition.typeTested.container.extension, SpecimenDefinition.typeTested.container.modifierExtension, SpecimenDefinition.typeTested.container.material, SpecimenDefinition.typeTested.container.type, SpecimenDefinition.typeTested.container.cap, SpecimenDefinition.typeTested.container.description, SpecimenDefinition.typeTested.container.capacity, SpecimenDefinition.typeTested.container.minimumVolume[x], SpecimenDefinition.typeTested.container.additive, SpecimenDefinition.typeTested.container.additive.extension, SpecimenDefinition.typeTested.container.additive.modifierExtension, SpecimenDefinition.typeTested.container.additive.additive[x], SpecimenDefinition.typeTested.container.additive.additive[x].extension, SpecimenDefinition.typeTested.container.additive.additive[x].extension:alternateReference, SpecimenDefinition.typeTested.container.preparation, SpecimenDefinition.typeTested.requirement, SpecimenDefinition.typeTested.retentionTime, SpecimenDefinition.typeTested.singleUse, SpecimenDefinition.typeTested.rejectionCriterion, SpecimenDefinition.typeTested.handling, SpecimenDefinition.typeTested.handling.extension, SpecimenDefinition.typeTested.handling.modifierExtension, SpecimenDefinition.typeTested.handling.temperatureQualifier, SpecimenDefinition.typeTested.handling.temperatureRange, SpecimenDefinition.typeTested.handling.maxDuration, SpecimenDefinition.typeTested.handling.instruction, SpecimenDefinition.typeTested.testingDestination | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.modifierExtension, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.modifierExtension, SpecimenDefinition.typeTested.container.extension, SpecimenDefinition.typeTested.container.modifierExtension, SpecimenDefinition.typeTested.container.additive.extension, SpecimenDefinition.typeTested.container.additive.modifierExtension, SpecimenDefinition.typeTested.container.additive.additive[x].extension, SpecimenDefinition.typeTested.container.additive.additive[x].extension:alternateReference, SpecimenDefinition.typeTested.handling.extension, SpecimenDefinition.typeTested.handling.modifierExtension | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
This structure is derived from SpecimenDefinition
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r4.r5#0.1.0 based on FHIR 5.0.0. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change