HL7 BE Laboratory WG Implementation Guide
1.0.1 - STU
HL7 BE Laboratory WG Implementation Guide
1.0.1 - STU
HL7 BE Laboratory WG Implementation Guide, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/lab/ and changes regularly. See the Directory of published versions
| Official URL: https://www.ehealth.fgov.be/standards/fhir/lab/StructureDefinition/be-specimen-laboratory | Version: 1.0.1 | |||
| Draft as of 2021-11-08 | Maturity Level: 1 | Computable Name: BeSpecimenLaboratory | ||
Belgian profile for a specimen in a laboratory report. In some laboratory reports, specimen information is allowed to be minimal as many informations concerning the specimen are implied by the observations done.
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 |
Specimen | |||
  text |
||||
  status |
1..1 | code | generated | extensions | additional | empty Required Pattern: empty | |
 identifier |
S | 0..* | Identifier | External Identifier |
| status |
S | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error |
| type |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
 subject |
S | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. |
| receivedTime |
S | 0..1 | dateTime | The time when specimen was received for processing |
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated |
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
| collection |
S | 0..1 | BackboneElement | Collection details |
| collected[x] |
0..1 | dateTime, Period | Collection time | |
| duration |
0..1 | Duration | How long it took to collect specimen | |
| quantity |
0..1 | SimpleQuantity | The quantity of specimen collected | |
| method |
0..1 | CodeableConcept | Technique used to perform collection | |
| bodySite |
0..1 | CodeableConcept | Anatomical collection site | |
| fastingStatus[x] |
0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink | |
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
| condition |
S | 0..* | CodeableConcept | State of the specimen |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
| 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 |
 identifier |
SΣ | 0..* | Identifier | External Identifier |
| status |
?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
| subject |
SΣ | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. |
| receivedTime |
SΣ | 0..1 | dateTime | The time when specimen was received for processing |
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated |
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
| collection |
S | 0..1 | BackboneElement | Collection details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
 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 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
 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 | |||
| fastingStatusDuration |
Duration | |||
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition |
SΣ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
| note |
S | 0..* | Annotation | Comments |
| 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 | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
| Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | |
| 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() |
| 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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status |
?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
| subject |
SΣ | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. | ||||
| receivedTime |
SΣ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated | ||||
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected | ||||
| collection |
S | 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 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| 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 | |||||||
| fastingStatusDuration |
Duration | |||||||
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |||||
| 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 |
SΣ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note |
S | 0..* | Annotation | Comments | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Specimen.text.status | required | Pattern: emptyhttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | ||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
| Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| 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() | |
| txt-1 | error | Specimen.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
| txt-2 | error | Specimen.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from Specimen
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Maturity: 1
Differential View
This structure is derived from Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Specimen |
Specimen | |||
| text |
||||
| status |
1..1 | code | generated | extensions | additional | empty Required Pattern: empty | |
| identifier |
S | 0..* | Identifier | External Identifier |
| status |
S | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error |
| type |
S | 0..1 | CodeableConcept | Kind of material that forms the specimen |
| subject |
S | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. |
| receivedTime |
S | 0..1 | dateTime | The time when specimen was received for processing |
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated |
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
| collection |
S | 0..1 | BackboneElement | Collection details |
| collected[x] |
0..1 | dateTime, Period | Collection time | |
| duration |
0..1 | Duration | How long it took to collect specimen | |
| quantity |
0..1 | SimpleQuantity | The quantity of specimen collected | |
| method |
0..1 | CodeableConcept | Technique used to perform collection | |
| bodySite |
0..1 | CodeableConcept | Anatomical collection site | |
| fastingStatus[x] |
0..1 | CodeableConcept, Duration | Whether or how long patient abstained from food and/or drink | |
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
| condition |
S | 0..* | CodeableConcept | State of the specimen |
| note |
S | 0..* | Annotation | Comments |
| Documentation for this format | ||||
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 |
| identifier |
SΣ | 0..* | Identifier | External Identifier |
| status |
?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. |
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. |
| subject |
SΣ | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. |
| receivedTime |
SΣ | 0..1 | dateTime | The time when specimen was received for processing |
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated |
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected |
| collection |
S | 0..1 | BackboneElement | Collection details |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| 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 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |
| 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 | |||
| fastingStatusDuration |
Duration | |||
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| container |
0..* | BackboneElement | Direct container of specimen (tube/slide, etc.) | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| condition |
SΣ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. |
| note |
S | 0..* | Annotation | Comments |
| 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 | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | |
| Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | |
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | |
| Specimen.collection.fastingStatus[x] | extensible | Hl7VSRelevantClincialInformationhttp://terminology.hl7.org/ValueSet/v2-0916 | |
| 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() |
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 | |||||
| id |
0..1 | string | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| status |
1..1 | code | generated | extensions | additional | empty Binding: NarrativeStatus (required): The status of a resource narrative. Required Pattern: empty | |||||
| div |
C | 1..1 | xhtml | Limited xhtml content txt-1: The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes txt-2: The narrative SHALL have some non-whitespace content | ||||
| contained |
0..* | Resource | Contained, inline Resources | |||||
| extension |
0..* | Extension | Additional content defined by implementations | |||||
| modifierExtension |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
| identifier |
SΣ | 0..* | Identifier | External Identifier | ||||
| accessionIdentifier |
Σ | 0..1 | Identifier | Identifier assigned by the lab | ||||
| status |
?!SΣ | 0..1 | code | available | unavailable | unsatisfactory | entered-in-error Binding: SpecimenStatus (required): Codes providing the status/availability of a specimen. | ||||
| type |
SΣ | 0..1 | CodeableConcept | Kind of material that forms the specimen Binding: hl7VS-specimenType (example): The type of the specimen. | ||||
| subject |
SΣ | 0..1 | Reference(Group | Device | Substance | Location | Patient core BE profile) | In the initial iteration of the Belgium lab project: when sending to eHealthBox, this is BePatient. | ||||
| receivedTime |
SΣ | 0..1 | dateTime | The time when specimen was received for processing | ||||
| parent |
S | 0..* | Reference(BeSpecimenLaboratory) | Specimen from which this specimen originated | ||||
| request |
S | 0..* | Reference(ServiceRequest) | Why the specimen was collected | ||||
| collection |
S | 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 | CodeableConcept | Technique used to perform collection Binding: FHIRSpecimenCollectionMethod (example): The technique that is used to perform the procedure. | |||||
| bodySite |
0..1 | CodeableConcept | Anatomical collection site Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality. | |||||
| 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 | |||||||
| fastingStatusDuration |
Duration | |||||||
| processing |
0..* | BackboneElement | Processing and processing step details to include when not implicit from specimen. | |||||
| 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 |
SΣ | 0..* | CodeableConcept | State of the specimen Binding: hl7VS-specimenCondition (extensible): Codes describing the state of the specimen. | ||||
| note |
S | 0..* | Annotation | Comments | ||||
| Documentation for this format | ||||||||
| Path | Conformance | ValueSet / Code | URI | |||
| Specimen.language | preferred | CommonLanguages
http://hl7.org/fhir/ValueSet/languagesfrom the FHIR Standard | ||||
| Specimen.text.status | required | Pattern: emptyhttp://hl7.org/fhir/ValueSet/narrative-status|4.0.1from the FHIR Standard | ||||
| Specimen.status | required | SpecimenStatushttp://hl7.org/fhir/ValueSet/specimen-status|4.0.1from the FHIR Standard | ||||
| Specimen.type | example | Hl7VSSpecimenTypehttp://terminology.hl7.org/ValueSet/v2-0487 | ||||
| Specimen.collection.method | example | FHIRSpecimenCollectionMethodhttp://hl7.org/fhir/ValueSet/specimen-collection-methodfrom the FHIR Standard | ||||
| Specimen.collection.bodySite | example | SNOMEDCTBodyStructureshttp://hl7.org/fhir/ValueSet/body-sitefrom the FHIR Standard | ||||
| 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() | |
| txt-1 | error | Specimen.text.div | The narrative SHALL contain only the basic html formatting elements and attributes described in chapters 7-11 (except section 4 of chapter 9) and 15 of the HTML 4.0 standard, <a> elements (either name or href), images and internally contained style attributes : htmlChecks() | |
| txt-2 | error | Specimen.text.div | The narrative SHALL have some non-whitespace content : htmlChecks() |
This structure is derived from Specimen
Summary
Must-Support: 10 elements
Structures
This structure refers to these other structures:
Maturity: 1
Other representations of profile: CSV, Excel, Schematron
IG © 2021+ eHealth Platform. Package hl7.fhir.be.lab#1.0.1 based on FHIR 4.0.1. Generated 2024-05-08
Links: Table of Contents |
QA Report |
Issues |
Version History |
Links: Table of Contents |
QA Report |
Version History 
|
|
Propose a change