Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4
0.1.0 - STU
Extensions for Using Data Elements from FHIR R5 in FHIR R4 - Downloaded Version null See the Directory of published versions
| Official URL: http://hl7.org/fhir/5.0/StructureDefinition/profile-SpecimenDefinition | Version: 0.1.0 | |||
| Standards status: Trial-use | Maturity Level: 0 | Computable Name: Profile_R5_SpecimenDefinition_R4 | ||
This cross-version profile allows R5 SpecimenDefinition content to be represented via FHIR R4 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.
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SpecimenDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SpecimenDefinition.implicitRules, SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status | 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(4.0.1) | 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: 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 | |||||
  Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
   extension:url |
0..1 | uri | R5: Logical canonical URL to reference this SpecimenDefinition (globally unique) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: Business version of the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this {{title}} (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this SpecimenDefinition (Human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:derivedFromCanonical |
0..* | canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) | R5: Based on FHIR definition of another SpecimenDefinition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.derivedFromCanonical Constraints: ext-1 | |||||
| extension:derivedFromUri |
0..* | uri | R5: Based on external definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.derivedFromUri Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: If this SpecimenDefinition is not for real usage (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group) | R5: Type of subject for specimen collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.subject Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: Date status first applied (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: The name of the individual or organization that published the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: Contact details for the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: Content intends to support these contexts (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| extension:jurisdiction |
0..* | CodeableConcept | R5: Intended jurisdiction for this SpecimenDefinition (if applicable) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.jurisdiction Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: Why this SpecimenDefinition is defined (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: When SpecimenDefinition was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: The date on which the asset content was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
 extension:effectivePeriod |
0..1 | Period | R5: The effective date range for the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
 Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:status |
?! | 1..1 | code | R5: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | ||||
| identifier |
Σ | 0..1 | Identifier | Business identifier of a kind of specimen | ||||
| 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): Checks on the patient prior specimen collection. | ||||
| timeAspect |
Σ | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge | ||||
| collection |
Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example): The action to collect a type of specimen. | ||||
 typeTested |
0..* | BackboneElement | Specimen in container intended for testing by lab | |||||
 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:singleUse |
0..1 | boolean | R5: Specimen for single use only (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.typeTested.singleUse Constraints: ext-1 | |||||
| extension:testingDestination |
0..* | CodeableConcept | R5: Where the specimen will be tested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.typeTested.testingDestination Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested. 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 | Container material Binding: ContainerMaterials (example): Types of material for specimen containers. | |||||
| type |
0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| cap |
0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example): Color of the container cap. | |||||
| description |
0..1 | string | Container description Example General: Blue top tube with citrate | |||||
| capacity |
0..1 | SimpleQuantity(4.0.1) | Container capacity | |||||
 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) | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| additiveCodeableConcept |
CodeableConcept | |||||||
 additiveReference |
Reference(Substance) | |||||||
| preparation |
0..1 | string | Specimen container preparation | |||||
| requirement |
0..1 | string | Specimen requirements | |||||
| retentionTime |
0..1 | Duration | Specimen retention time | |||||
| rejectionCriterion |
0..* | CodeableConcept | Rejection criterion 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 | Temperature qualifier Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen. | |||||
| temperatureRange |
0..1 | Range | Temperature range | |||||
| maxDuration |
0..1 | Duration | Maximum preservation time | |||||
| instruction |
0..1 | string | Preservation instruction Example General: freeze within 4 hours | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| SpecimenDefinition.typeCollected | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.patientPreparation | Base | example | Patient preparation prior specimen collection | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.collection | Base | example | Specimen collection methods | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.preference | Base | required | SpecimenContainedPreference | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.material | Base | example | Types of material for specimen containers | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.cap | Base | example | ContainerCap | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.additive.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.rejectionCriterion | Base | example | RejectionCriterion | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | Base | example | HandlingConditionSet | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SpecimenDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SpecimenDefinition.meta, SpecimenDefinition.implicitRules, SpecimenDefinition.language, SpecimenDefinition.text, SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status, SpecimenDefinition.identifier, SpecimenDefinition.typeCollected, SpecimenDefinition.patientPreparation, SpecimenDefinition.timeAspect, SpecimenDefinition.collection, SpecimenDefinition.typeTested, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.extension:singleUse, SpecimenDefinition.typeTested.extension:testingDestination, 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.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 | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.extension:singleUse, SpecimenDefinition.typeTested.extension:testingDestination, 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
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
Maturity: 0
Key Elements View
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SpecimenDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SpecimenDefinition.implicitRules, SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status | Must have either extensions or value[x], not both |
extension.exists() != value.exists()
|
Differential View
This structure is derived from SpecimenDefinition
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| SpecimenDefinition |
0..* | SpecimenDefinition(4.0.1) | 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: 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 | |||||
| Slices for extension |
0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||
| extension:url |
0..1 | uri | R5: Logical canonical URL to reference this SpecimenDefinition (globally unique) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-url Constraints: ext-1 | |||||
| extension:version |
0..1 | string | R5: Business version of the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-version Constraints: ext-1 | |||||
| extension:versionAlgorithm |
0..1 | Coding | R5: How to compare versions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-versionAlgorithm Binding: version-algorithm (??) (extensible) Constraints: ext-1 | |||||
| extension:name |
0..1 | string | R5: Name for this {{title}} (computer friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-name Constraints: ext-1 | |||||
| extension:title |
0..1 | string | R5: Name for this SpecimenDefinition (Human friendly) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-title Constraints: ext-1 | |||||
| extension:derivedFromCanonical |
0..* | canonical(Cross-version Profile for R5.SpecimenDefinition for use in FHIR R4(0.1.0) | SpecimenDefinition) | R5: Based on FHIR definition of another SpecimenDefinition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.derivedFromCanonical Constraints: ext-1 | |||||
| extension:derivedFromUri |
0..* | uri | R5: Based on external definition (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.derivedFromUri Constraints: ext-1 | |||||
| extension:experimental |
0..1 | boolean | R5: If this SpecimenDefinition is not for real usage (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-experimental Constraints: ext-1 | |||||
| extension:subject |
0..1 | CodeableConcept, Reference(Cross-version Profile for R5.Group for use in FHIR R4(0.1.0) | Group) | R5: Type of subject for specimen collection (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.subject Constraints: ext-1 | |||||
| extension:date |
0..1 | dateTime | R5: Date status first applied (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-date Constraints: ext-1 | |||||
| extension:publisher |
0..1 | string | R5: The name of the individual or organization that published the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-publisher Constraints: ext-1 | |||||
| extension:contact |
0..* | ContactDetail | R5: Contact details for the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-contact Constraints: ext-1 | |||||
| extension:description |
0..1 | markdown | R5: Natural language description of the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-description Constraints: ext-1 | |||||
| extension:useContext |
0..* | UsageContext | R5: Content intends to support these contexts (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-useContext Constraints: ext-1 | |||||
| extension:jurisdiction |
0..* | CodeableConcept | R5: Intended jurisdiction for this SpecimenDefinition (if applicable) (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.jurisdiction Constraints: ext-1 | |||||
| extension:purpose |
0..1 | markdown | R5: Why this SpecimenDefinition is defined (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-purpose Constraints: ext-1 | |||||
| extension:copyright |
0..1 | markdown | R5: Use and/or publishing restrictions (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyright Constraints: ext-1 | |||||
| extension:copyrightLabel |
0..1 | string | R5: Copyright holder and year(s) (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-copyrightLabel Constraints: ext-1 | |||||
| extension:approvalDate |
0..1 | date | R5: When SpecimenDefinition was approved by publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-approvalDate Constraints: ext-1 | |||||
| extension:lastReviewDate |
0..1 | date | R5: The date on which the asset content was last reviewed by the publisher (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-lastReviewDate Constraints: ext-1 | |||||
| extension:effectivePeriod |
0..1 | Period | R5: The effective date range for the SpecimenDefinition (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-effectivePeriod Constraints: ext-1 | |||||
| Slices for modifierExtension |
?! | 0..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||
| modifierExtension:status |
?! | 1..1 | code | R5: draft | active | retired | unknown (new) URL: http://hl7.org/fhir/StructureDefinition/artifact-status Binding: PublicationStatus (required): The lifecycle status of an artifact. Constraints: ext-1 | ||||
| identifier |
Σ | 0..1 | Identifier | Business identifier of a kind of specimen | ||||
| 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): Checks on the patient prior specimen collection. | ||||
| timeAspect |
Σ | 0..1 | string | Time aspect for collection Example General: 24 hour, 20' post charge | ||||
| collection |
Σ | 0..* | CodeableConcept | Specimen collection procedure Binding: SpecimenCollection (example): The action to collect a type of specimen. | ||||
| typeTested |
0..* | BackboneElement | Specimen in container intended for testing by lab | |||||
| 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:singleUse |
0..1 | boolean | R5: Specimen for single use only (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.typeTested.singleUse Constraints: ext-1 | |||||
| extension:testingDestination |
0..* | CodeableConcept | R5: Where the specimen will be tested (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-SpecimenDefinition.typeTested.testingDestination Binding: DiagnosticServiceSectionCodes (example): Codes specifying where the specimen will be tested. 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 | Container material Binding: ContainerMaterials (example): Types of material for specimen containers. | |||||
| type |
0..1 | CodeableConcept | Kind of container associated with the kind of specimen Binding: SpecimenContainerType (example): Type of specimen container. | |||||
| cap |
0..1 | CodeableConcept | Color of container cap Binding: ContainerCap (example): Color of the container cap. | |||||
| description |
0..1 | string | Container description Example General: Blue top tube with citrate | |||||
| capacity |
0..1 | SimpleQuantity(4.0.1) | Container capacity | |||||
| 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) | R5: additive additional types URL: http://hl7.org/fhir/StructureDefinition/alternate-reference Constraints: ext-1 | |||||
| additiveCodeableConcept |
CodeableConcept | |||||||
| additiveReference |
Reference(Substance) | |||||||
| preparation |
0..1 | string | Specimen container preparation | |||||
| requirement |
0..1 | string | Specimen requirements | |||||
| retentionTime |
0..1 | Duration | Specimen retention time | |||||
| rejectionCriterion |
0..* | CodeableConcept | Rejection criterion 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 | Temperature qualifier Binding: HandlingConditionSet (example): Set of handling instructions prior testing of the specimen. | |||||
| temperatureRange |
0..1 | Range | Temperature range | |||||
| maxDuration |
0..1 | Duration | Maximum preservation time | |||||
| instruction |
0..1 | string | Preservation instruction Example General: freeze within 4 hours | |||||
| Documentation for this format | ||||||||
| Path | Status | Usage | ValueSet | Version | Source |
| SpecimenDefinition.language | Base | preferred |
Common Languages
|
📍4.0.1 | tx.fhir.org |
| SpecimenDefinition.typeCollected | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.patientPreparation | Base | example | Patient preparation prior specimen collection | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.collection | Base | example | Specimen collection methods | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.type | Base | example | hl7VS-specimenType | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.preference | Base | required | SpecimenContainedPreference | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.material | Base | example | Types of material for specimen containers | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.type | Base | example | Specimen Container Type | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.cap | Base | example | ContainerCap | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.container.additive.additive[x] | Base | example | hl7VS-additivePreservative | 📍3.0.0 | THO v7.1 |
| SpecimenDefinition.typeTested.rejectionCriterion | Base | example | RejectionCriterion | 📍4.0.1 | FHIR Std. |
| SpecimenDefinition.typeTested.handling.temperatureQualifier | Base | example | HandlingConditionSet | 📍4.0.1 | FHIR Std. |
| Id | Grade | Path(s) | Description | Expression |
| dom-2 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL NOT contain nested Resources |
contained.contained.empty()
|
| dom-3 | error | SpecimenDefinition | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource |
contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
|
| dom-4 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated |
contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
|
| dom-5 | error | SpecimenDefinition | If a resource is contained in another resource, it SHALL NOT have a security label |
contained.meta.security.empty()
|
| dom-6 | best practice | SpecimenDefinition | A resource should have narrative for robust management |
text.`div`.exists()
|
| ele-1 | error | SpecimenDefinition.meta, SpecimenDefinition.implicitRules, SpecimenDefinition.language, SpecimenDefinition.text, SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status, SpecimenDefinition.identifier, SpecimenDefinition.typeCollected, SpecimenDefinition.patientPreparation, SpecimenDefinition.timeAspect, SpecimenDefinition.collection, SpecimenDefinition.typeTested, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.extension:singleUse, SpecimenDefinition.typeTested.extension:testingDestination, 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.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 | All FHIR elements must have a @value or children |
hasValue() or (children().count() > id.count())
|
| ext-1 | error | SpecimenDefinition.extension, SpecimenDefinition.extension:url, SpecimenDefinition.extension:version, SpecimenDefinition.extension:versionAlgorithm, SpecimenDefinition.extension:name, SpecimenDefinition.extension:title, SpecimenDefinition.extension:derivedFromCanonical, SpecimenDefinition.extension:derivedFromUri, SpecimenDefinition.extension:experimental, SpecimenDefinition.extension:subject, SpecimenDefinition.extension:date, SpecimenDefinition.extension:publisher, SpecimenDefinition.extension:contact, SpecimenDefinition.extension:description, SpecimenDefinition.extension:useContext, SpecimenDefinition.extension:jurisdiction, SpecimenDefinition.extension:purpose, SpecimenDefinition.extension:copyright, SpecimenDefinition.extension:copyrightLabel, SpecimenDefinition.extension:approvalDate, SpecimenDefinition.extension:lastReviewDate, SpecimenDefinition.extension:effectivePeriod, SpecimenDefinition.modifierExtension, SpecimenDefinition.modifierExtension:status, SpecimenDefinition.typeTested.extension, SpecimenDefinition.typeTested.extension:singleUse, SpecimenDefinition.typeTested.extension:testingDestination, 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
Summary
Mandatory: 1 element
Extensions
This structure refers to these extensions:
Maturity: 0
Other representations of profile: CSV, Excel, Schematron
IG © 2025+ FHIR Infrastructure. Package hl7.fhir.uv.xver-r5.r4#0.1.0 based on FHIR 4.0.1. Generated 2026-03-20
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change