FHIR IG analytics| Package | zw.fhir.ig.lab |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-zw-lab-order.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/mohcc/fhir-zw-lab-ig/StructureDefinition-zw-lab-order.html |
| URL | http://mohcc.gov.zw/fhir/lab/StructureDefinition/zw-lab-order |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-06-11T12:18:23+00:00 |
| Name | ZWLabOrder |
| Title | ZW Lab Order (ZW.LAB.A1) |
| Description | Logical model for ordering a laboratory test in Zimbabwe. Covers all data elements defined in activity ZW.LAB.A1 of the Zimbabwe Lab DAK data dictionary. |
| Type | http://mohcc.gov.zw/fhir/lab/StructureDefinition/zw-lab-order |
| Kind | logical |
No resources found
| ValueSet | ||
| zw.fhir.ig.lab#current | zw-lab-tests | ZW Laboratory Tests |
| zw.fhir.ig.lab#current | zw-laboratories | ZW National Laboratory List |
| zw.fhir.ig.lab#current | zw-reason-for-test | ZW Reason for Test |
| zw.fhir.ig.lab#current | zw-sample-types | ZW Specimen Types |
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition zw-lab-order
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  zw-lab-order | 0..* | Base | ZW Lab Order (ZW.LAB.A1) | |
  ehrPatientId | 1..1 | string | EHR Patient ID (ZW.LAB.A.DE1) | |
 clientIdentifier | 0..1 | Identifier | Client Identifier (ZW.LAB.A.DE2) | |
| name | 0..1 | HumanName | Client Name (ZW.LAB.A.DE3-DE4) | |
| dateOfBirth | 1..1 | date | Date of Birth (ZW.LAB.A.DE5) | |
| sex | 1..1 | code | Sex (ZW.LAB.A.DE6) Binding: AdministrativeGender (required) | |
| artNumber | 0..1 | string | ART Number (ZW.LAB.A.DE9) | |
| receivingLaboratory | 0..1 | CodeableConcept | Receiving Laboratory (ZW.LAB.A.DE10) Binding: ZW National Laboratory List (required) | |
| orderingFacility | 1..1 | string | Ordering Facility (ZW.LAB.A.DE11) | |
| orderStatus | 0..1 | code | Order Status (ZW.LAB.A.DE12) | |
| pregnant | 0..1 | boolean | Pregnant (ZW.LAB.A.DE13) | |
| breastfeeding | 0..1 | boolean | Breastfeeding (ZW.LAB.A.DE14) | |
| artStartDate | 0..1 | date | ART Start Date (ZW.LAB.A.DE15) | |
| currentArtRegimen | 0..1 | string | Current ART Regimen (ZW.LAB.A.DE16) | |
| testRequested | 1..1 | CodeableConcept | Test Requested (ZW.LAB.A.DE17) Binding: ZW Laboratory Tests (required) | |
| reasonForTest | 1..1 | CodeableConcept | Reason for Test (ZW.LAB.A.DE30) Binding: ZW Reason for Test (required) | |
| clientSampleId | 0..1 | string | Client Sample Identifier (ZW.LAB.A.DE52) | |
| sampleType | 0..1 | CodeableConcept | Sample Type (ZW.LAB.A.DE53) Binding: ZW Specimen Types (preferred) | |
 dateCollected | 0..1 | dateTime | Date Collected (ZW.LAB.A.DE72) | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "zw-lab-order",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://mohcc.gov.zw/fhir/lab/StructureDefinition/zw-lab-order",
"version": "0.1.0",
"name": "ZWLabOrder",
"title": "ZW Lab Order (ZW.LAB.A1)",
"status": "active",
"date": "2026-06-11T12:18:23+00:00",
"publisher": "MOH Zimbabwe",
"contact": [
{
"name": "MOH Zimbabwe",
"telecom": [
{
"system": "url",
"value": "http://mohcc.org.zw"
}
]
}
],
"description": "Logical model for ordering a laboratory test in Zimbabwe. Covers all data elements defined in activity ZW.LAB.A1 of the Zimbabwe Lab DAK data dictionary.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "716",
"display": "Zimbabwe (ZWE)"
}
]
}
],
"fhirVersion": "4.0.1",
"kind": "logical",
"abstract": false,
"type": "http://mohcc.gov.zw/fhir/lab/StructureDefinition/zw-lab-order",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "4.0.1"
}
],
"element": [
{
"id": "zw-lab-order",
"path": "zw-lab-order",
"short": "ZW Lab Order (ZW.LAB.A1)",
"definition": "Logical model for ordering a laboratory test in Zimbabwe. Covers all data elements defined in activity ZW.LAB.A1 of the Zimbabwe Lab DAK data dictionary.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false
},
{
"id": "zw-lab-order.ehrPatientId",
"path": "zw-lab-order.ehrPatientId",
"short": "EHR Patient ID (ZW.LAB.A.DE1)",
"definition": "Unique identifier of the client in the ordering EMR.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.ehrPatientId",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.clientIdentifier",
"path": "zw-lab-order.clientIdentifier",
"short": "Client Identifier (ZW.LAB.A.DE2)",
"definition": "National or other client identifier used for identity matching.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.clientIdentifier",
"min": 0,
"max": "1"
},
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "zw-lab-order.name",
"path": "zw-lab-order.name",
"short": "Client Name (ZW.LAB.A.DE3-DE4)",
"definition": "Client's given name (DE3) and family name (DE4).",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.name",
"min": 0,
"max": "1"
},
"type": [
{
"code": "HumanName"
}
]
},
{
"id": "zw-lab-order.dateOfBirth",
"path": "zw-lab-order.dateOfBirth",
"short": "Date of Birth (ZW.LAB.A.DE5)",
"definition": "Client's date of birth.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.dateOfBirth",
"min": 1,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "zw-lab-order.sex",
"path": "zw-lab-order.sex",
"short": "Sex (ZW.LAB.A.DE6)",
"definition": "Client's administrative sex.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.sex",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"id": "zw-lab-order.artNumber",
"path": "zw-lab-order.artNumber",
"short": "ART Number (ZW.LAB.A.DE9)",
"definition": "Client's antiretroviral therapy (ART) number.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.artNumber",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.receivingLaboratory",
"path": "zw-lab-order.receivingLaboratory",
"short": "Receiving Laboratory (ZW.LAB.A.DE10)",
"definition": "Laboratory designated to perform the order, coded against the national laboratory list.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.receivingLaboratory",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-laboratories"
}
},
{
"id": "zw-lab-order.orderingFacility",
"path": "zw-lab-order.orderingFacility",
"short": "Ordering Facility (ZW.LAB.A.DE11)",
"definition": "Health facility placing the order.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.orderingFacility",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.orderStatus",
"path": "zw-lab-order.orderStatus",
"short": "Order Status (ZW.LAB.A.DE12)",
"definition": "Lifecycle status of the fulfilment of the laboratory order.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.orderStatus",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "zw-lab-order.pregnant",
"path": "zw-lab-order.pregnant",
"short": "Pregnant (ZW.LAB.A.DE13)",
"definition": "Whether the client is pregnant at time of ordering.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.pregnant",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "zw-lab-order.breastfeeding",
"path": "zw-lab-order.breastfeeding",
"short": "Breastfeeding (ZW.LAB.A.DE14)",
"definition": "Whether the client is breastfeeding at time of ordering.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.breastfeeding",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "zw-lab-order.artStartDate",
"path": "zw-lab-order.artStartDate",
"short": "ART Start Date (ZW.LAB.A.DE15)",
"definition": "Date the client started antiretroviral therapy.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.artStartDate",
"min": 0,
"max": "1"
},
"type": [
{
"code": "date"
}
]
},
{
"id": "zw-lab-order.currentArtRegimen",
"path": "zw-lab-order.currentArtRegimen",
"short": "Current ART Regimen (ZW.LAB.A.DE16)",
"definition": "Client's current ART regimen.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.currentArtRegimen",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.testRequested",
"path": "zw-lab-order.testRequested",
"short": "Test Requested (ZW.LAB.A.DE17)",
"definition": "Laboratory test being requested, coded against the national test list.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.testRequested",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-lab-tests"
}
},
{
"id": "zw-lab-order.reasonForTest",
"path": "zw-lab-order.reasonForTest",
"short": "Reason for Test (ZW.LAB.A.DE30)",
"definition": "Clinical reason the test is being requested.",
"min": 1,
"max": "1",
"base": {
"path": "zw-lab-order.reasonForTest",
"min": 1,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-reason-for-test"
}
},
{
"id": "zw-lab-order.clientSampleId",
"path": "zw-lab-order.clientSampleId",
"short": "Client Sample Identifier (ZW.LAB.A.DE52)",
"definition": "Identifier assigned to the specimen at collection; the exchange key linking specimen, order and result.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.clientSampleId",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.sampleType",
"path": "zw-lab-order.sampleType",
"short": "Sample Type (ZW.LAB.A.DE53)",
"definition": "Type of specimen collected, coded against the national sample type list.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.sampleType",
"min": 0,
"max": "1"
},
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-sample-types"
}
},
{
"id": "zw-lab-order.dateCollected",
"path": "zw-lab-order.dateCollected",
"short": "Date Collected (ZW.LAB.A.DE72)",
"definition": "Date and time the specimen was collected.",
"min": 0,
"max": "1",
"base": {
"path": "zw-lab-order.dateCollected",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
}
]
},
"differential": {
"element": [
{
"id": "zw-lab-order",
"path": "zw-lab-order",
"short": "ZW Lab Order (ZW.LAB.A1)",
"definition": "Logical model for ordering a laboratory test in Zimbabwe. Covers all data elements defined in activity ZW.LAB.A1 of the Zimbabwe Lab DAK data dictionary."
},
{
"id": "zw-lab-order.ehrPatientId",
"path": "zw-lab-order.ehrPatientId",
"short": "EHR Patient ID (ZW.LAB.A.DE1)",
"definition": "Unique identifier of the client in the ordering EMR.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.clientIdentifier",
"path": "zw-lab-order.clientIdentifier",
"short": "Client Identifier (ZW.LAB.A.DE2)",
"definition": "National or other client identifier used for identity matching.",
"min": 0,
"max": "1",
"type": [
{
"code": "Identifier"
}
]
},
{
"id": "zw-lab-order.name",
"path": "zw-lab-order.name",
"short": "Client Name (ZW.LAB.A.DE3-DE4)",
"definition": "Client's given name (DE3) and family name (DE4).",
"min": 0,
"max": "1",
"type": [
{
"code": "HumanName"
}
]
},
{
"id": "zw-lab-order.dateOfBirth",
"path": "zw-lab-order.dateOfBirth",
"short": "Date of Birth (ZW.LAB.A.DE5)",
"definition": "Client's date of birth.",
"min": 1,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "zw-lab-order.sex",
"path": "zw-lab-order.sex",
"short": "Sex (ZW.LAB.A.DE6)",
"definition": "Client's administrative sex.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
],
"binding": {
"strength": "required",
"valueSet": "http://hl7.org/fhir/ValueSet/administrative-gender"
}
},
{
"id": "zw-lab-order.artNumber",
"path": "zw-lab-order.artNumber",
"short": "ART Number (ZW.LAB.A.DE9)",
"definition": "Client's antiretroviral therapy (ART) number.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.receivingLaboratory",
"path": "zw-lab-order.receivingLaboratory",
"short": "Receiving Laboratory (ZW.LAB.A.DE10)",
"definition": "Laboratory designated to perform the order, coded against the national laboratory list.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-laboratories"
}
},
{
"id": "zw-lab-order.orderingFacility",
"path": "zw-lab-order.orderingFacility",
"short": "Ordering Facility (ZW.LAB.A.DE11)",
"definition": "Health facility placing the order.",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.orderStatus",
"path": "zw-lab-order.orderStatus",
"short": "Order Status (ZW.LAB.A.DE12)",
"definition": "Lifecycle status of the fulfilment of the laboratory order.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "zw-lab-order.pregnant",
"path": "zw-lab-order.pregnant",
"short": "Pregnant (ZW.LAB.A.DE13)",
"definition": "Whether the client is pregnant at time of ordering.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "zw-lab-order.breastfeeding",
"path": "zw-lab-order.breastfeeding",
"short": "Breastfeeding (ZW.LAB.A.DE14)",
"definition": "Whether the client is breastfeeding at time of ordering.",
"min": 0,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "zw-lab-order.artStartDate",
"path": "zw-lab-order.artStartDate",
"short": "ART Start Date (ZW.LAB.A.DE15)",
"definition": "Date the client started antiretroviral therapy.",
"min": 0,
"max": "1",
"type": [
{
"code": "date"
}
]
},
{
"id": "zw-lab-order.currentArtRegimen",
"path": "zw-lab-order.currentArtRegimen",
"short": "Current ART Regimen (ZW.LAB.A.DE16)",
"definition": "Client's current ART regimen.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.testRequested",
"path": "zw-lab-order.testRequested",
"short": "Test Requested (ZW.LAB.A.DE17)",
"definition": "Laboratory test being requested, coded against the national test list.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-lab-tests"
}
},
{
"id": "zw-lab-order.reasonForTest",
"path": "zw-lab-order.reasonForTest",
"short": "Reason for Test (ZW.LAB.A.DE30)",
"definition": "Clinical reason the test is being requested.",
"min": 1,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "required",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-reason-for-test"
}
},
{
"id": "zw-lab-order.clientSampleId",
"path": "zw-lab-order.clientSampleId",
"short": "Client Sample Identifier (ZW.LAB.A.DE52)",
"definition": "Identifier assigned to the specimen at collection; the exchange key linking specimen, order and result.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "zw-lab-order.sampleType",
"path": "zw-lab-order.sampleType",
"short": "Sample Type (ZW.LAB.A.DE53)",
"definition": "Type of specimen collected, coded against the national sample type list.",
"min": 0,
"max": "1",
"type": [
{
"code": "CodeableConcept"
}
],
"binding": {
"strength": "preferred",
"valueSet": "http://mohcc.gov.zw/fhir/lab/ValueSet/zw-sample-types"
}
},
{
"id": "zw-lab-order.dateCollected",
"path": "zw-lab-order.dateCollected",
"short": "Date Collected (ZW.LAB.A.DE72)",
"definition": "Date and time the specimen was collected.",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
}
]
}
}