| Package | hl7.fhir.uv.omop |
| Type | StructureDefinition |
| Id | Specimen |
| FHIR Version | R5 |
| Source | http://hl7.org/fhir/uv/omop/https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-Specimen.html |
| URL | http://hl7.org/fhir/uv/omop/StructureDefinition/Specimen |
| Version | 0.1.0 |
| Status | draft |
| Date | 2025-07-21T21:36:05+00:00 |
| Name | Specimen |
| Title | Specimen OMOP Table |
| Realm | uv |
| Authority | hl7 |
| Description | The specimen domain contains the records identifying biological samples from a person. |
| Type | http://hl7.org/fhir/uv/omop/StructureDefinition/Specimen |
| Kind | logical |
No resources found
| StructureDefinition | |
| Person | Person OMOP Table |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition Specimen
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Specimen | 0..* | Base | Specimen OMOP Table Instances of this logical model can be the target of a Reference | |
  specimen_id | 1..1 | code | Specimen Identifier | |
 person_id | 1..1 | Reference(Person OMOP Table) | Person | |
| specimen_concept_id | 1..1 | code | Specimen | |
| specimen_type_concept_id | 1..1 | code | Specimen Type | |
| specimen_date | 1..1 | date | Specimen Date | |
| specimen_datetime | 0..1 | dateTime | Specimen Datetime | |
| quantity | 0..1 | integer | Quantity | |
| unit_concept_id | 0..1 | code | Unit | |
| anatomic_site_concept_id | 0..1 | code | Anatomic Site | |
| disease_status_concept_id | 0..1 | code | Disease Status | |
| specimen_source_id | 0..1 | string | Specimen Source | |
| specimen_source_value | 0..1 | string | Specimen Source Value | |
| unit_source_value | 0..1 | string | Unit Source Value | |
| anatomic_site_source_value | 0..1 | string | Anatomic Site Source Value | |
 disease_status_source_value | 0..1 | string | Disease Site Source Value | |
| Documentation for this format | ||||
FHIR{
"resourceType": "StructureDefinition",
"id": "Specimen",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "brr"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "draft",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Specimen",
"version": "0.1.0",
"name": "Specimen",
"title": "Specimen OMOP Table",
"status": "draft",
"date": "2025-07-21T21:36:05+00:00",
"publisher": "HL7 International / Biomedical Research and Regulation",
"contact": [
{
"name": "HL7 International / Biomedical Research and Regulation",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/rcrim"
}
]
}
],
"description": "The specimen domain contains the records identifying biological samples from a person.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Specimen",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Specimen",
"path": "Specimen",
"short": "Specimen OMOP Table",
"definition": "The specimen domain contains the records identifying biological samples from a person.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Specimen.specimen-id",
"path": "Specimen.specimen_id",
"short": "Specimen Identifier",
"definition": "Specimen Identifier",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.specimen_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.person-id",
"path": "Specimen.person_id",
"short": "Person",
"definition": "The person from whom the specimen is collected.",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.person_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
]
}
]
},
{
"id": "Specimen.specimen-concept-id",
"path": "Specimen.specimen_concept_id",
"short": "Specimen",
"definition": "Specimen",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.specimen_concept_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-type-concept-id",
"path": "Specimen.specimen_type_concept_id",
"short": "Specimen Type",
"definition": "Specimen Type",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.specimen_type_concept_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-date",
"path": "Specimen.specimen_date",
"short": "Specimen Date",
"definition": "The date the specimen was collected.",
"min": 1,
"max": "1",
"base": {
"path": "Specimen.specimen_date",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "Specimen.specimen-datetime",
"path": "Specimen.specimen_datetime",
"short": "Specimen Datetime",
"definition": "Specimen Datetime",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.specimen_datetime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Specimen.quantity",
"path": "Specimen.quantity",
"short": "Quantity",
"definition": "The amount of specimen collected from the person.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.quantity",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Specimen.unit-concept-id",
"path": "Specimen.unit_concept_id",
"short": "Unit",
"definition": "The unit for the quantity of the specimen.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.unit_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.anatomic-site-concept-id",
"path": "Specimen.anatomic_site_concept_id",
"short": "Anatomic Site",
"definition": "This is the site on the body where the specimen is from.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.anatomic_site_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.disease-status-concept-id",
"path": "Specimen.disease_status_concept_id",
"short": "Disease Status",
"definition": "Disease Status",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.disease_status_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-source-id",
"path": "Specimen.specimen_source_id",
"short": "Specimen Source",
"definition": "This is the identifier for the specimen from the source system.",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.specimen_source_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.specimen-source-value",
"path": "Specimen.specimen_source_value",
"short": "Specimen Source Value",
"definition": "Specimen Source Value",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.specimen_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.unit-source-value",
"path": "Specimen.unit_source_value",
"short": "Unit Source Value",
"definition": "Unit Source Value",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.unit_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.anatomic-site-source-value",
"path": "Specimen.anatomic_site_source_value",
"short": "Anatomic Site Source Value",
"definition": "Anatomic Site Source Value",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.anatomic_site_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.disease-status-source-value",
"path": "Specimen.disease_status_source_value",
"short": "Disease Site Source Value",
"definition": "Disease Site Source Value",
"min": 0,
"max": "1",
"base": {
"path": "Specimen.disease_status_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Specimen",
"path": "Specimen",
"short": "Specimen OMOP Table",
"definition": "The specimen domain contains the records identifying biological samples from a person."
},
{
"id": "Specimen.specimen-id",
"path": "Specimen.specimen_id",
"short": "Specimen Identifier",
"definition": "Specimen Identifier",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.person-id",
"path": "Specimen.person_id",
"short": "Person",
"definition": "The person from whom the specimen is collected.",
"min": 1,
"max": "1",
"type": [
{
"code": "Reference",
"targetProfile": [
"http://hl7.org/fhir/uv/omop/StructureDefinition/Person"
]
}
]
},
{
"id": "Specimen.specimen-concept-id",
"path": "Specimen.specimen_concept_id",
"short": "Specimen",
"definition": "Specimen",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-type-concept-id",
"path": "Specimen.specimen_type_concept_id",
"short": "Specimen Type",
"definition": "Specimen Type",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-date",
"path": "Specimen.specimen_date",
"short": "Specimen Date",
"definition": "The date the specimen was collected.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "Specimen.specimen-datetime",
"path": "Specimen.specimen_datetime",
"short": "Specimen Datetime",
"definition": "Specimen Datetime",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Specimen.quantity",
"path": "Specimen.quantity",
"short": "Quantity",
"definition": "The amount of specimen collected from the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Specimen.unit-concept-id",
"path": "Specimen.unit_concept_id",
"short": "Unit",
"definition": "The unit for the quantity of the specimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.anatomic-site-concept-id",
"path": "Specimen.anatomic_site_concept_id",
"short": "Anatomic Site",
"definition": "This is the site on the body where the specimen is from.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.disease-status-concept-id",
"path": "Specimen.disease_status_concept_id",
"short": "Disease Status",
"definition": "Disease Status",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Specimen.specimen-source-id",
"path": "Specimen.specimen_source_id",
"short": "Specimen Source",
"definition": "This is the identifier for the specimen from the source system.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.specimen-source-value",
"path": "Specimen.specimen_source_value",
"short": "Specimen Source Value",
"definition": "Specimen Source Value",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.unit-source-value",
"path": "Specimen.unit_source_value",
"short": "Unit Source Value",
"definition": "Unit Source Value",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.anatomic-site-source-value",
"path": "Specimen.anatomic_site_source_value",
"short": "Anatomic Site Source Value",
"definition": "Anatomic Site Source Value",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Specimen.disease-status-source-value",
"path": "Specimen.disease_status_source_value",
"short": "Disease Site Source Value",
"definition": "Disease Site Source Value",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
}
]
}
}