FHIR IG analytics| Package | tz.nhif.zhsf.claims |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-tz-claim-submission-request.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/Speedykom/tanzania-nhif-zhsf-claims-ig/StructureDefinition-tz-claim-submission-request.html |
| URL | https://build.fhir.org/ig/speedykom/tanzania-nhif-zhsf-claims-ig/StructureDefinition/tz-claim-submission-request |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-01-12T12:56:31+00:00 |
| Name | TZClaimSubmissionRequest |
| Title | TZ Claim Submission Request (ZHSF JSON) |
| Description | Logical model representing the ZHSF Claim Submission JSON request payload. This model defines the facade contract and is validated before transformation to FHIR R5 resources. |
| Type | https://build.fhir.org/ig/speedykom/tanzania-nhif-zhsf-claims-ig/StructureDefinition/tz-claim-submission-request |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition tz-claim-submission-request
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  tz-claim-submission-request | 0..* | Base | TZ Claim Submission Request (ZHSF JSON) | |
  facilityCode | 1..1 | string | Facility code | |
| practitionerRegistrationNo | 1..1 | string | Practitioner registration number | |
| authorizationNumber | 1..1 | string | Authorization number | |
| clinicalNotes | 0..1 | string | Clinical notes | |
| referralNo | 0..1 | integer | Referral number | |
| isAdmited | 1..1 | boolean | Is admitted | |
| mrn | 1..1 | string | Medical Record Number | |
 claimsItems | 1..* | BackboneElement | Claim items | |
 itemCode | 1..1 | string | Item code | |
| itemQuantity | 1..1 | integer | Item quantity | |
| frequency | 0..1 | string | Frequency | |
 issuedNo | 0..1 | integer | Issued number | |
| preliminaryDiagnosisCode | 0..* | string | Preliminary diagnosis codes | |
| finalDiagnosisCode | 0..* | string | Final diagnosis codes | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "tz-claim-submission-request",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "https://build.fhir.org/ig/speedykom/tanzania-nhif-zhsf-claims-ig/StructureDefinition/tz-claim-submission-request",
"version": "0.1.0",
"name": "TZClaimSubmissionRequest",
"title": "TZ Claim Submission Request (ZHSF JSON)",
"status": "active",
"date": "2026-01-12T12:56:31+00:00",
"publisher": "Speedykom GmbH",
"contact": [
{
"name": "Speedykom GmbH",
"telecom": [
{
"system": "url",
"value": "https://www.speedykom.de"
}
]
},
{
"name": "Ahmed Amri",
"telecom": [
{
"system": "email",
"value": "ahmed.amri@speedykom.de",
"use": "work"
}
]
}
],
"description": "Logical model representing the ZHSF Claim Submission JSON request payload.\nThis model defines the facade contract and is validated before transformation\nto FHIR R5 resources.",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "TZ",
"display": "Tanzania"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "https://build.fhir.org/ig/speedykom/tanzania-nhif-zhsf-claims-ig/StructureDefinition/tz-claim-submission-request",
"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": "tz-claim-submission-request",
"path": "tz-claim-submission-request",
"short": "TZ Claim Submission Request (ZHSF JSON)",
"definition": "Logical model representing the ZHSF Claim Submission JSON request payload.\nThis model defines the facade contract and is validated before transformation\nto FHIR R5 resources.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "tz-claim-submission-request.facilityCode",
"path": "tz-claim-submission-request.facilityCode",
"short": "Facility code",
"definition": "ZHSF facility identifier code",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.facilityCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.practitionerRegistrationNo",
"path": "tz-claim-submission-request.practitionerRegistrationNo",
"short": "Practitioner registration number",
"definition": "Registered practitioner identifier",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.practitionerRegistrationNo",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.authorizationNumber",
"path": "tz-claim-submission-request.authorizationNumber",
"short": "Authorization number",
"definition": "Authorization number issued during eligibility/approval",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.authorizationNumber",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.clinicalNotes",
"path": "tz-claim-submission-request.clinicalNotes",
"short": "Clinical notes",
"definition": "Optional free-text clinical notes",
"min": 0,
"max": "1",
"base": {
"path": "tz-claim-submission-request.clinicalNotes",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.referralNo",
"path": "tz-claim-submission-request.referralNo",
"short": "Referral number",
"definition": "Referral number if applicable (often 0)",
"min": 0,
"max": "1",
"base": {
"path": "tz-claim-submission-request.referralNo",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.isAdmited",
"path": "tz-claim-submission-request.isAdmited",
"short": "Is admitted",
"definition": "Admission flag (true if inpatient)",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.isAdmited",
"min": 1,
"max": "1"
},
"type": [
{
"code": "boolean"
}
]
},
{
"id": "tz-claim-submission-request.mrn",
"path": "tz-claim-submission-request.mrn",
"short": "Medical Record Number",
"definition": "Facility medical record number",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.mrn",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems",
"path": "tz-claim-submission-request.claimsItems",
"short": "Claim items",
"definition": "List of claim line items",
"min": 1,
"max": "*",
"base": {
"path": "tz-claim-submission-request.claimsItems",
"min": 1,
"max": "*"
},
"type": [
{
"code": "BackboneElement"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.id",
"path": "tz-claim-submission-request.claimsItems.id",
"representation": [
"xmlAttr"
],
"short": "Unique id for inter-element referencing",
"definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
"min": 0,
"max": "1",
"base": {
"path": "Element.id",
"min": 0,
"max": "1"
},
"type": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
"valueUrl": "id"
}
],
"code": "http://hl7.org/fhirpath/System.String"
}
],
"condition": [
"ele-1"
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.extension",
"path": "tz-claim-submission-request.claimsItems.extension",
"slicing": {
"discriminator": [
{
"type": "value",
"path": "url"
}
],
"description": "Extensions are always sliced by (at least) url",
"rules": "open"
},
"short": "Additional content defined by implementations",
"definition": "May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"alias": [
"extensions",
"user content"
],
"min": 0,
"max": "*",
"base": {
"path": "Element.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": false,
"isSummary": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.modifierExtension",
"path": "tz-claim-submission-request.claimsItems.modifierExtension",
"short": "Extensions that cannot be ignored even if unrecognized",
"definition": "May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.\n\nModifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).",
"comment": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.",
"requirements": "Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R5/extensibility.html#modifierExtension).",
"alias": [
"extensions",
"user content",
"modifiers"
],
"min": 0,
"max": "*",
"base": {
"path": "BackboneElement.modifierExtension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"key": "ele-1",
"severity": "error",
"human": "All FHIR elements must have a @value or children",
"expression": "hasValue() or (children().count() > id.count())",
"source": "http://hl7.org/fhir/StructureDefinition/Element"
},
{
"key": "ext-1",
"severity": "error",
"human": "Must have either extensions or value[x], not both",
"expression": "extension.exists() != value.exists()",
"source": "http://hl7.org/fhir/StructureDefinition/Extension"
}
],
"isModifier": true,
"isModifierReason": "Modifier extensions are expected to modify the meaning or interpretation of the element that contains them",
"isSummary": true,
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.itemCode",
"path": "tz-claim-submission-request.claimsItems.itemCode",
"short": "Item code",
"definition": "Service, medication, or procedure code",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.claimsItems.itemCode",
"min": 1,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.itemQuantity",
"path": "tz-claim-submission-request.claimsItems.itemQuantity",
"short": "Item quantity",
"definition": "Quantity for the claim item",
"min": 1,
"max": "1",
"base": {
"path": "tz-claim-submission-request.claimsItems.itemQuantity",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.frequency",
"path": "tz-claim-submission-request.claimsItems.frequency",
"short": "Frequency",
"definition": "Optional frequency information",
"min": 0,
"max": "1",
"base": {
"path": "tz-claim-submission-request.claimsItems.frequency",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.issuedNo",
"path": "tz-claim-submission-request.claimsItems.issuedNo",
"short": "Issued number",
"definition": "Issued number when pre-approval is required",
"min": 0,
"max": "1",
"base": {
"path": "tz-claim-submission-request.claimsItems.issuedNo",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.preliminaryDiagnosisCode",
"path": "tz-claim-submission-request.preliminaryDiagnosisCode",
"short": "Preliminary diagnosis codes",
"definition": "Diagnosis codes captured during encounter",
"min": 0,
"max": "*",
"base": {
"path": "tz-claim-submission-request.preliminaryDiagnosisCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.finalDiagnosisCode",
"path": "tz-claim-submission-request.finalDiagnosisCode",
"short": "Final diagnosis codes",
"definition": "Diagnosis codes confirmed after encounter",
"min": 0,
"max": "*",
"base": {
"path": "tz-claim-submission-request.finalDiagnosisCode",
"min": 0,
"max": "*"
},
"type": [
{
"code": "string"
}
]
}
]
},
"differential": {
"element": [
{
"id": "tz-claim-submission-request",
"path": "tz-claim-submission-request",
"short": "TZ Claim Submission Request (ZHSF JSON)",
"definition": "Logical model representing the ZHSF Claim Submission JSON request payload.\nThis model defines the facade contract and is validated before transformation\nto FHIR R5 resources."
},
{
"id": "tz-claim-submission-request.facilityCode",
"path": "tz-claim-submission-request.facilityCode",
"short": "Facility code",
"definition": "ZHSF facility identifier code",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.practitionerRegistrationNo",
"path": "tz-claim-submission-request.practitionerRegistrationNo",
"short": "Practitioner registration number",
"definition": "Registered practitioner identifier",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.authorizationNumber",
"path": "tz-claim-submission-request.authorizationNumber",
"short": "Authorization number",
"definition": "Authorization number issued during eligibility/approval",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.clinicalNotes",
"path": "tz-claim-submission-request.clinicalNotes",
"short": "Clinical notes",
"definition": "Optional free-text clinical notes",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.referralNo",
"path": "tz-claim-submission-request.referralNo",
"short": "Referral number",
"definition": "Referral number if applicable (often 0)",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.isAdmited",
"path": "tz-claim-submission-request.isAdmited",
"short": "Is admitted",
"definition": "Admission flag (true if inpatient)",
"min": 1,
"max": "1",
"type": [
{
"code": "boolean"
}
]
},
{
"id": "tz-claim-submission-request.mrn",
"path": "tz-claim-submission-request.mrn",
"short": "Medical Record Number",
"definition": "Facility medical record number",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems",
"path": "tz-claim-submission-request.claimsItems",
"short": "Claim items",
"definition": "List of claim line items",
"min": 1,
"max": "*",
"type": [
{
"code": "BackboneElement"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.itemCode",
"path": "tz-claim-submission-request.claimsItems.itemCode",
"short": "Item code",
"definition": "Service, medication, or procedure code",
"min": 1,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.itemQuantity",
"path": "tz-claim-submission-request.claimsItems.itemQuantity",
"short": "Item quantity",
"definition": "Quantity for the claim item",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.frequency",
"path": "tz-claim-submission-request.claimsItems.frequency",
"short": "Frequency",
"definition": "Optional frequency information",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.claimsItems.issuedNo",
"path": "tz-claim-submission-request.claimsItems.issuedNo",
"short": "Issued number",
"definition": "Issued number when pre-approval is required",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "tz-claim-submission-request.preliminaryDiagnosisCode",
"path": "tz-claim-submission-request.preliminaryDiagnosisCode",
"short": "Preliminary diagnosis codes",
"definition": "Diagnosis codes captured during encounter",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
},
{
"id": "tz-claim-submission-request.finalDiagnosisCode",
"path": "tz-claim-submission-request.finalDiagnosisCode",
"short": "Final diagnosis codes",
"definition": "Diagnosis codes confirmed after encounter",
"min": 0,
"max": "*",
"type": [
{
"code": "string"
}
]
}
]
}
}