HL7® FHIR® Malaysia Core (MY Core) Implementation Guide - Local Development build (v2.0.1) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Resource Profile: SpecimenDefinition (MY Core)

A kind of specimen with associated set of requirements.

Usages:

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

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• Key Elements Table
• Differential Table
• Snapshot Table
• Statistics/References
• All

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SpecimenDefinition		0..*	SpecimenDefinition	Kind of specimen
typeTested
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SpecimenDefinition.typeTested.container.type	required	ValueSetSpecimenContainerTypeMyCore(a valid code from CodeSystemSpecimenContainerType (MY Core)) http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core From this IG

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
extension: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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SpecimenDefinition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
SpecimenDefinition.typeCollected	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.patientPreparation	example	PreparePatient http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection From the FHIR Standard
SpecimenDefinition.collection	example	SpecimenCollection http://hl7.org/fhir/ValueSet/specimen-collection From the FHIR Standard
SpecimenDefinition.typeTested.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.typeTested.preference	required	SpecimenContainedPreference http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1 From the FHIR Standard
SpecimenDefinition.typeTested.container.material	example	ContainerMaterials http://hl7.org/fhir/ValueSet/container-material From the FHIR Standard
SpecimenDefinition.typeTested.container.type	required	ValueSetSpecimenContainerTypeMyCore(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.cap	example	ContainerCap http://hl7.org/fhir/ValueSet/container-cap From the FHIR Standard
SpecimenDefinition.typeTested.container.additive.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
SpecimenDefinition.typeTested.rejectionCriterion	example	RejectionCriterion http://hl7.org/fhir/ValueSet/rejection-criteria From the FHIR Standard
SpecimenDefinition.typeTested.handling.temperatureQualifier	example	HandlingConditionSet http://hl7.org/fhir/ValueSet/handling-condition From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

Mandatory: 0 element(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

• http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
Documentation for this format

Constraints

Id	Grade	Path(s)	Details	Requirements
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	**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()

Differential View

This structure is derived from SpecimenDefinition

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
SpecimenDefinition		0..*	SpecimenDefinition	Kind of specimen
typeTested
Slices for extension		1..*	Extension	Extension Slice: Unordered, Open by value:url
extension: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)
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
SpecimenDefinition.typeTested.container.type	required	ValueSetSpecimenContainerTypeMyCore(a valid code from CodeSystemSpecimenContainerType (MY Core)) http://fhir.hie.moh.gov.my/ValueSet/specimen-container-type-my-core From this IG

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
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
extension: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
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
SpecimenDefinition.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
SpecimenDefinition.typeCollected	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.patientPreparation	example	PreparePatient http://hl7.org/fhir/ValueSet/prepare-patient-prior-specimen-collection From the FHIR Standard
SpecimenDefinition.collection	example	SpecimenCollection http://hl7.org/fhir/ValueSet/specimen-collection From the FHIR Standard
SpecimenDefinition.typeTested.type	example	Hl7VSSpecimenType http://terminology.hl7.org/ValueSet/v2-0487
SpecimenDefinition.typeTested.preference	required	SpecimenContainedPreference http://hl7.org/fhir/ValueSet/specimen-contained-preference|4.0.1 From the FHIR Standard
SpecimenDefinition.typeTested.container.material	example	ContainerMaterials http://hl7.org/fhir/ValueSet/container-material From the FHIR Standard
SpecimenDefinition.typeTested.container.type	required	ValueSetSpecimenContainerTypeMyCore(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.cap	example	ContainerCap http://hl7.org/fhir/ValueSet/container-cap From the FHIR Standard
SpecimenDefinition.typeTested.container.additive.additive[x]	example	Hl7VSAdditivePreservative http://terminology.hl7.org/ValueSet/v2-0371
SpecimenDefinition.typeTested.rejectionCriterion	example	RejectionCriterion http://hl7.org/fhir/ValueSet/rejection-criteria From the FHIR Standard
SpecimenDefinition.typeTested.handling.temperatureQualifier	example	HandlingConditionSet http://hl7.org/fhir/ValueSet/handling-condition From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
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	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()

This structure is derived from SpecimenDefinition

Summary

Mandatory: 0 element(3 nested mandatory elements)

Extensions

This structure refers to these extensions:

• http://fhir.hie.moh.gov.my/StructureDefinition/specimen-combine-sample-my-core

Other representations of profile: CSV, Excel, Schematron

Notes: