ImplementationGuide for Malaysia Core (MY Core)
0.0.1 - CI Build

ImplementationGuide for Malaysia Core (MY Core), published by Malaysia Healthcare Nexus (MHN). This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nhphong245/my-core-ig-r4/ and changes regularly. See the Directory of published versions

Resource Profile: SpecimenDefinition (MY Core)

Official URL: http://fhir.hie.moh.gov.my/StructureDefinition/SpecimenDefinition-my-core Version: 0.0.1
Active as of 2024-03-13 Responsible: Malaysia Healthcare Nexus (MHN) Realm: International flag Computable Name: SpecimenDefinitionMyCore

Usage:

  • This Resource Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... typeTested
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... combineSample 1..1 boolean Extension to determine whether the lab test allows combining the same sample with another lab test
URL: http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core
.... container
..... type 1..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: ValueSetSpecimenContainerType (MY Core) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SpecimenDefinition.typeTested.container.typerequiredValueSetSpecimenContainerTypeMyCore (a valid code from CodeSystemSpecimenContainerType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Business identifier of a kind of specimen
... typeCollected Σ 0..1 CodeableConcept Kind of material to collect
Binding: hl7VS-specimenType (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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... combineSample 1..1 boolean Extension to determine whether the lab test allows combining the same sample with another lab test
URL: http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... isDerived 0..1 boolean Primary or secondary specimen
Example General: false
.... type 0..1 CodeableConcept Type of intended specimen
Binding: hl7VS-specimenType (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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... material 0..1 CodeableConcept Container material
Binding: ContainerMaterials (example): Types of material for specimen containers.

..... type 1..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: ValueSetSpecimenContainerType (MY Core) (required)
..... 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 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... additive[x] 1..1 Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SpecimenDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
SpecimenDefinition.typeCollectedexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.patientPreparationexamplePreparePatient
http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection
from the FHIR Standard
SpecimenDefinition.collectionexampleSpecimenCollection
http://hl7.org/fhir/ValueSet/specimen-collection
from the FHIR Standard
SpecimenDefinition.typeTested.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.typeTested.preferencerequiredSpecimenContainedPreference
http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1
from the FHIR Standard
SpecimenDefinition.typeTested.container.materialexampleContainerMaterials
http://hl7.org/fhir/ValueSet/container-material
from the FHIR Standard
SpecimenDefinition.typeTested.container.typerequiredValueSetSpecimenContainerTypeMyCore (a valid code from CodeSystemSpecimenContainerType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core
from this IG
SpecimenDefinition.typeTested.container.capexampleContainerCap
http://hl7.org/fhir/ValueSet/container-cap
from the FHIR Standard
SpecimenDefinition.typeTested.container.additive.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
SpecimenDefinition.typeTested.rejectionCriterionexampleRejectionCriterion
http://hl7.org/fhir/ValueSet/rejection-criteria
from the FHIR Standard
SpecimenDefinition.typeTested.handling.temperatureQualifierexampleHandlingConditionSet
http://hl7.org/fhir/ValueSet/handling-condition
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

Mandatory: 0 element(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

Differential View

This structure is derived from SpecimenDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... typeTested
.... extension 1..* Extension Extension
.... Slices for extension Content/Rules for all slices
..... combineSample 1..1 boolean Extension to determine whether the lab test allows combining the same sample with another lab test
URL: http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core
.... container
..... type 1..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: ValueSetSpecimenContainerType (MY Core) (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
SpecimenDefinition.typeTested.container.typerequiredValueSetSpecimenContainerTypeMyCore (a valid code from CodeSystemSpecimenContainerType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition Kind of specimen
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. SpecimenDefinition 0..* SpecimenDefinition 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
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..1 Identifier Business identifier of a kind of specimen
... typeCollected Σ 0..1 CodeableConcept Kind of material to collect
Binding: hl7VS-specimenType (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 1..* Extension Extension
Slice: Unordered, Open by value:url
..... combineSample 1..1 boolean Extension to determine whether the lab test allows combining the same sample with another lab test
URL: http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... isDerived 0..1 boolean Primary or secondary specimen
Example General: false
.... type 0..1 CodeableConcept Type of intended specimen
Binding: hl7VS-specimenType (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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... material 0..1 CodeableConcept Container material
Binding: ContainerMaterials (example): Types of material for specimen containers.

..... type 1..1 CodeableConcept Kind of container associated with the kind of specimen
Binding: ValueSetSpecimenContainerType (MY Core) (required)
..... 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 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
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... additive[x] 1..1 Additive associated with container
Binding: hl7VS-additivePreservative (example): Substance added to specimen container.

....... 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
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... 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

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
SpecimenDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
SpecimenDefinition.typeCollectedexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.patientPreparationexamplePreparePatient
http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection
from the FHIR Standard
SpecimenDefinition.collectionexampleSpecimenCollection
http://hl7.org/fhir/ValueSet/specimen-collection
from the FHIR Standard
SpecimenDefinition.typeTested.typeexampleHl7VSSpecimenType
http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.typeTested.preferencerequiredSpecimenContainedPreference
http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1
from the FHIR Standard
SpecimenDefinition.typeTested.container.materialexampleContainerMaterials
http://hl7.org/fhir/ValueSet/container-material
from the FHIR Standard
SpecimenDefinition.typeTested.container.typerequiredValueSetSpecimenContainerTypeMyCore (a valid code from CodeSystemSpecimenContainerType (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core
from this IG
SpecimenDefinition.typeTested.container.capexampleContainerCap
http://hl7.org/fhir/ValueSet/container-cap
from the FHIR Standard
SpecimenDefinition.typeTested.container.additive.additive[x]exampleHl7VSAdditivePreservative
http://terminology.hl7.org/ValueSet/v2-0371
SpecimenDefinition.typeTested.rejectionCriterionexampleRejectionCriterion
http://hl7.org/fhir/ValueSet/rejection-criteria
from the FHIR Standard
SpecimenDefinition.typeTested.handling.temperatureQualifierexampleHandlingConditionSet
http://hl7.org/fhir/ValueSet/handling-condition
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorSpecimenDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorSpecimenDefinitionIf 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-4errorSpecimenDefinitionIf 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-5errorSpecimenDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceSpecimenDefinitionA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

Mandatory: 0 element(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron