{
"description": "A sample to be used for analysis.",
"_filename": "Specimen.json",
"package_name": "hl7.fhir.r4.id.core",
"date": "2019-11-01T09:29:23+11:00",
"derivation": "specialization",
"meta": {
"lastUpdated": "2021-12-31T09:15:10.958+00:00"
},
"publisher": "Health Level Seven International (Orders and Observations)",
"fhirVersion": "4.0.1",
"name": "Specimen",
"mapping": [ {
"uri": "http://hl7.org/v3",
"name": "RIM Mapping",
"identity": "rim"
}, {
"uri": "http://hl7.org/fhir/fivews",
"name": "FiveWs Pattern Mapping",
"identity": "w5"
}, {
"uri": "http://hl7.org/v2",
"name": "HL7 v2 Mapping",
"identity": "v2"
} ],
"abstract": false,
"type": "Specimen",
"experimental": null,
"resourceType": "StructureDefinition",
"title": null,
"package_version": "0.1.0",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-category",
"valueString": "Clinical.Diagnostics"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "trial-use"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 2
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-security-category",
"valueCode": "patient"
}, {
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "oo"
} ],
"status": "draft",
"id": "8e4d0108-0bdf-4fa7-afa5-c8957f1f31a0",
"kind": "resource",
"url": "https://fhir.kemkes.go.id/r4/StructureDefinition/Specimen",
"version": "4.0.1",
"differential": {
"element": [ {
"id": "Specimen",
"path": "Specimen",
"short": "Sample for analysis",
"mapping": [ {
"map": "Role[classCode=SPEC]",
"identity": "rim"
} ],
"definition": "A sample to be used for analysis."
}, {
"id": "Specimen.identifier",
"path": "Specimen.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "External Identifier",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "SPM-2",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Id for specimen."
}, {
"id": "Specimen.accessionIdentifier",
"max": "1",
"path": "Specimen.accessionIdentifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Identifier assigned by the lab",
"mapping": [ {
"map": "FiveWs.identifier",
"identity": "w5"
}, {
"map": "SPM-30 (v2.7+)",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=ACSN, moodCode=EVN].id",
"identity": "rim"
} ],
"isSummary": true,
"definition": "The identifier assigned by the lab when accessioning specimen(s). This is not necessarily the same as the specimen identifier, depending on local lab procedures."
}, {
"path": "Specimen.status",
"definition": "The availability of the specimen.",
"isModifier": true,
"short": "available | unavailable | unsatisfactory | entered-in-error",
"mapping": [ {
"map": "FiveWs.status",
"identity": "w5"
}, {
"map": "SPM-20",
"identity": "v2"
}, {
"map": "status",
"identity": "rim"
} ],
"type": [ {
"code": "code"
} ],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-status|4.0.1",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenStatus"
} ],
"description": "Codes providing the status/availability of a specimen."
},
"max": "1",
"id": "Specimen.status",
"comment": "This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.",
"isModifierReason": "This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid",
"isSummary": true
}, {
"path": "Specimen.type",
"definition": "The kind of material that forms the specimen.",
"short": "Kind of material that forms the specimen",
"mapping": [ {
"map": "FiveWs.what[x]",
"identity": "w5"
}, {
"map": "SPM-4 and possibly SPM-5",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0487",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenType"
} ],
"description": "The type of the specimen."
},
"max": "1",
"id": "Specimen.type",
"comment": "The type can change the way that a specimen is handled and drives what kind of analyses can properly be performed on the specimen. It is frequently used in diagnostic work flow decision making systems.",
"isSummary": true
}, {
"path": "Specimen.subject",
"requirements": "Must know the subject context.",
"definition": "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device.",
"short": "Where the specimen came from. This may be from patient(s), from a location (e.g., the source of an environmental sample), or a sampling of a substance or a device",
"mapping": [ {
"map": "FiveWs.subject[x]",
"identity": "w5"
}, {
"map": ".scoper or .scoper.playsRole",
"identity": "rim"
}, {
"map": "FiveWs.subject",
"identity": "w5"
} ],
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Patient", "http://hl7.org/fhir/StructureDefinition/Group", "http://hl7.org/fhir/StructureDefinition/Device", "http://hl7.org/fhir/StructureDefinition/Substance", "http://hl7.org/fhir/StructureDefinition/Location" ]
} ],
"max": "1",
"id": "Specimen.subject",
"isSummary": true
}, {
"id": "Specimen.receivedTime",
"max": "1",
"path": "Specimen.receivedTime",
"type": [ {
"code": "dateTime"
} ],
"short": "The time when specimen was received for processing",
"mapping": [ {
"map": "FiveWs.done[x]",
"identity": "w5"
}, {
"map": "SPM-18",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[code=SPCREC, moodCode=EVN].effectiveTime",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Time when specimen was received for processing or testing."
}, {
"id": "Specimen.parent",
"path": "Specimen.parent",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Specimen" ]
} ],
"short": "Specimen from which this specimen originated",
"comment": "The parent specimen could be the source from which the current specimen is derived by some processing step (e.g. an aliquot or isolate or extracted nucleic acids from clinical samples) or one of many specimens that were combined to create a pooled sample.",
"mapping": [ {
"map": ".scoper (if parent) .player.scopesRole[classCode=SPEC].player (if child)",
"identity": "rim"
} ],
"definition": "Reference to the parent (source) specimen which is used when the specimen was either derived from or a component of another specimen."
}, {
"id": "Specimen.request",
"path": "Specimen.request",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/ServiceRequest" ]
} ],
"short": "Why the specimen was collected",
"comment": "The request may be explicit or implied such with a ServiceRequest that requires a blood draw.",
"mapping": [ {
"map": "FiveWs.why[x]",
"identity": "w5"
}, {
"map": "ORC? OBR-2/3?",
"identity": "v2"
}, {
"map": "outboundRelationship[typeCode=FLFS].target",
"identity": "rim"
} ],
"definition": "Details concerning a service request that required a specimen to be collected."
}, {
"id": "Specimen.collection",
"max": "1",
"path": "Specimen.collection",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Collection details",
"mapping": [ {
"map": "SPM-14",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].act[classCode=SPECCOLLECT, moodCode=EVN]",
"identity": "rim"
} ],
"definition": "Details concerning the specimen collection."
}, {
"id": "Specimen.collection.collector",
"max": "1",
"path": "Specimen.collection.collector",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Practitioner", "http://hl7.org/fhir/StructureDefinition/PractitionerRole" ]
} ],
"short": "Who collected the specimen",
"mapping": [ {
"map": "FiveWs.actor",
"identity": "w5"
}, {
"map": "PRT",
"identity": "v2"
}, {
"map": ".participation[typeCode=PFM].role",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Person who collected the specimen."
}, {
"id": "Specimen.collection.collected[x]",
"max": "1",
"path": "Specimen.collection.collected[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"short": "Collection time",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
}, {
"map": "SPM-17",
"identity": "v2"
}, {
"map": ".effectiveTime",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Time when specimen was collected from subject - the physiologically relevant time."
}, {
"id": "Specimen.collection.duration",
"max": "1",
"path": "Specimen.collection.duration",
"type": [ {
"code": "Duration"
} ],
"short": "How long it took to collect specimen",
"mapping": [ {
"map": "FiveWs.init",
"identity": "w5"
} ],
"isSummary": true,
"definition": "The span of time over which the collection of a specimen occurred."
}, {
"id": "Specimen.collection.quantity",
"max": "1",
"path": "Specimen.collection.quantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"short": "The quantity of specimen collected",
"mapping": [ {
"map": "SPM-12",
"identity": "v2"
}, {
"map": ".participation[typeCode=SBJ].role[classCode=SPEC].player.quantity",
"identity": "rim"
} ],
"definition": "The quantity of specimen collected; for instance the volume of a blood sample, or the physical measurement of an anatomic pathology sample."
}, {
"id": "Specimen.collection.method",
"max": "1",
"path": "Specimen.collection.method",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Technique used to perform collection",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-collection-method",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCollectionMethod"
} ],
"description": "The technique that is used to perform the procedure."
},
"mapping": [ {
"map": "SPM-7",
"identity": "v2"
}, {
"map": ".methodCode",
"identity": "rim"
} ],
"definition": "A coded value specifying the technique that is used to perform the procedure."
}, {
"path": "Specimen.collection.bodySite",
"definition": "Anatomical location from which the specimen was collected (if subject is a patient). This is the target site. This element is not used for environmental specimens.",
"short": "Anatomical collection site",
"mapping": [ {
"map": "SPM-8 and SPM-9",
"identity": "v2"
}, {
"map": ".targetSiteCode",
"identity": "rim"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/body-site",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "BodySite"
} ],
"description": "Codes describing anatomical locations. May include laterality."
},
"max": "1",
"id": "Specimen.collection.bodySite",
"comment": "If the use case requires BodySite to be handled as a separate resource instead of an inline coded element (e.g. to identify and track separately) then use the standard extension [bodySite](extension-bodysite.html)."
}, {
"path": "Specimen.collection.fastingStatus[x]",
"requirements": "Many diagnostic tests require fasting to facilitate accurate interpretation.",
"definition": "Abstinence or reduction from some or all food, drink, or both, for a period of time prior to sample collection.",
"short": "Whether or how long patient abstained from food and/or drink",
"mapping": [ {
"map": "OBR-",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Duration"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0916",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "FastingStatus"
} ],
"description": "Codes describing the fasting status of the patient."
},
"max": "1",
"id": "Specimen.collection.fastingStatus[x]",
"comment": "Representing fasting status using this element is preferred to representing it with an observation using a 'pre-coordinated code' such as LOINC 2005-7 (Calcium [Moles/time] in 2 hour Urine --12 hours fasting), or using a component observation ` such as `Observation.component code` = LOINC 49541-6 (Fasting status - Reported).",
"isSummary": true
}, {
"id": "Specimen.processing",
"path": "Specimen.processing",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Processing and processing step details",
"mapping": [ {
"map": ".participation[typeCode=SBJ].act[code=SPCTRT, moodCode=EVN]",
"identity": "rim"
} ],
"definition": "Details concerning processing and processing steps for the specimen."
}, {
"id": "Specimen.processing.description",
"max": "1",
"path": "Specimen.processing.description",
"type": [ {
"code": "string"
} ],
"short": "Textual description of procedure",
"mapping": [ {
"map": ".text",
"identity": "rim"
} ],
"definition": "Textual description of procedure."
}, {
"id": "Specimen.processing.procedure",
"max": "1",
"path": "Specimen.processing.procedure",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Indicates the treatment step applied to the specimen",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-processing-procedure",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenProcessingProcedure"
} ],
"description": "Type indicating the technique used to process the specimen."
},
"mapping": [ {
"map": ".code",
"identity": "rim"
} ],
"definition": "A coded value specifying the procedure used to process the specimen."
}, {
"id": "Specimen.processing.additive",
"path": "Specimen.processing.additive",
"type": [ {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"short": "Material used in the processing step",
"mapping": [ {
"map": "SPM-6",
"identity": "v2"
}, {
"map": ".participation[typeCode=CSM].role[classCode=ADTV].code",
"identity": "rim"
} ],
"definition": "Material used in the processing step."
}, {
"id": "Specimen.processing.time[x]",
"max": "1",
"path": "Specimen.processing.time[x]",
"type": [ {
"code": "dateTime"
}, {
"code": "Period"
} ],
"short": "Date and time of specimen processing",
"mapping": [ {
"map": ".effectiveTime",
"identity": "rim"
} ],
"definition": "A record of the time or period when the specimen processing occurred. For example the time of sample fixation or the period of time the sample was in formalin."
}, {
"id": "Specimen.container",
"path": "Specimen.container",
"type": [ {
"code": "BackboneElement"
} ],
"short": "Direct container of specimen (tube/slide, etc.)",
"mapping": [ {
"map": ".player.scopingRole[classCode=CONT].scoper",
"identity": "rim"
} ],
"definition": "The container holding the specimen. The recursive nature of containers; i.e. blood in tube in tray in rack is not addressed here."
}, {
"id": "Specimen.container.identifier",
"path": "Specimen.container.identifier",
"type": [ {
"code": "Identifier"
} ],
"short": "Id for the container",
"mapping": [ {
"map": "SAC-3",
"identity": "v2"
}, {
"map": ".id",
"identity": "rim"
} ],
"isSummary": true,
"definition": "Id for container. There may be multiple; a manufacturer's bar code, lab assigned identifier, etc. The container ID may differ from the specimen id in some circumstances."
}, {
"id": "Specimen.container.description",
"max": "1",
"path": "Specimen.container.description",
"type": [ {
"code": "string"
} ],
"short": "Textual description of the container",
"mapping": [ {
"map": ".desc",
"identity": "rim"
} ],
"definition": "Textual description of the container."
}, {
"id": "Specimen.container.type",
"max": "1",
"path": "Specimen.container.type",
"type": [ {
"code": "CodeableConcept"
} ],
"short": "Kind of container directly associated with specimen",
"binding": {
"strength": "example",
"valueSet": "http://hl7.org/fhir/ValueSet/specimen-container-type",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerType"
} ],
"description": "Type of specimen container."
},
"mapping": [ {
"map": "SPM-27",
"identity": "v2"
}, {
"map": ".code",
"identity": "rim"
} ],
"definition": "The type of container associated with the specimen (e.g. slide, aliquot, etc.)."
}, {
"id": "Specimen.container.capacity",
"max": "1",
"path": "Specimen.container.capacity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"short": "Container volume or size",
"mapping": [ {
"map": "one of: SAC 16, SAC17 and SAC 20, or SAC 21 and SAC 20",
"identity": "v2"
}, {
"map": ".quantity",
"identity": "rim"
} ],
"definition": "The capacity (volume or other measure) the container may contain."
}, {
"id": "Specimen.container.specimenQuantity",
"max": "1",
"path": "Specimen.container.specimenQuantity",
"type": [ {
"code": "Quantity",
"profile": [ "http://hl7.org/fhir/StructureDefinition/SimpleQuantity" ]
} ],
"short": "Quantity of specimen within container",
"mapping": [ {
"map": "SAC-23 (value) SAC-24 (units",
"identity": "v2"
}, {
"map": ".playedRole[classCode=CONT].quantity",
"identity": "rim"
} ],
"definition": "The quantity of specimen in the container; may be volume, dimensions, or other appropriate measurements, depending on the specimen type."
}, {
"id": "Specimen.container.additive[x]",
"max": "1",
"path": "Specimen.container.additive[x]",
"type": [ {
"code": "CodeableConcept"
}, {
"code": "Reference",
"targetProfile": [ "http://hl7.org/fhir/StructureDefinition/Substance" ]
} ],
"short": "Additive associated with container",
"binding": {
"strength": "example",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0371",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenContainerAdditive"
} ],
"description": "Substance added to specimen container."
},
"mapping": [ {
"map": "SAC-27",
"identity": "v2"
}, {
"map": ".scopesRole[classCode=ADTV].player",
"identity": "rim"
} ],
"definition": "Introduced substance to preserve, maintain or enhance the specimen. Examples: Formalin, Citrate, EDTA."
}, {
"path": "Specimen.condition",
"requirements": "The specimen condition can be used to assess its quality or appropriateness for a specific test.",
"definition": "A mode or state of being that describes the nature of the specimen.",
"short": "State of the specimen",
"mapping": [ {
"map": "SPM-24",
"identity": "v2"
} ],
"type": [ {
"code": "CodeableConcept"
} ],
"binding": {
"strength": "extensible",
"valueSet": "http://terminology.hl7.org/ValueSet/v2-0493",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/elementdefinition-bindingName",
"valueString": "SpecimenCondition"
} ],
"description": "Codes describing the state of the specimen."
},
"id": "Specimen.condition",
"comment": "Specimen condition is an observation made about the specimen. It's a point-in-time assessment. It can be used to assess its quality or appropriateness for a specific test.",
"isSummary": true
}, {
"id": "Specimen.note",
"path": "Specimen.note",
"type": [ {
"code": "Annotation"
} ],
"short": "Comments",
"mapping": [ {
"map": "OBX",
"identity": "v2"
}, {
"map": ".inboundRelationship[typeCode=SUBJ].source[classCode=OBS, moodCode=EVN, code=\"annotation\"].value",
"identity": "rim"
} ],
"definition": "To communicate any details or issues about the specimen or during the specimen collection. (for example: broken vial, sent with patient, frozen)."
} ]
},
"contact": [ {
"telecom": [ {
"value": "http://hl7.org/fhir",
"system": "url"
} ]
}, {
"telecom": [ {
"value": "http://www.hl7.org/Special/committees/orders/index.cfm",
"system": "url"
} ]
} ],
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/DomainResource"
}