SMART PH4H
0.9.9 - release

This page is part of the PH4H (v0.9.9: Releases Draft) based on FHIR (HL7® FHIR® Standard) R4. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Logical Model: Medication Treatment Line (Minimal)

Official URL: http://smart.who.int/ph4h/StructureDefinition/MedicationTreatmentLineMin Version: 0.9.9
Draft as of 2026-07-09 Computable Name: MedicationTreatmentLineMin

Minimal medication treatment line payload for use within a QR code payload. Based on the IHE Pharmacy Medication Treatment Line logical model, with short element labels (one or two letters) and simple data types suitable for encoding in a compact QR code payload.

Usages:

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.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.

API Information

Medication Treatment Line (Minimal) API

Minimal medication treatment line payload for use within a QR code payload. Based on the IHE Pharmacy Medication Treatment Line logical model, with short element labels (one or two letters) and simple data types suitable for encoding in a compact QR code payload.

Version: 1.0.0

Endpoints

GET /StructureDefinition-MedicationTreatmentLineMin.schema.json

JSON Schema definition for the Logical Model StructureDefinition-MedicationTreatmentLineMin

This endpoint serves the JSON Schema definition for the Logical Model StructureDefinition-MedicationTreatmentLineMin.

Schema Definition

StructureDefinition-MedicationTreatmentLineMin

Description: Minimal medication treatment line payload for use within a QR code payload. Based on the IHE Pharmacy Medication Treatment Line logical model, with short element labels (one or two letters) and simple data types suitable for encoding in a compact QR code payload.

Type: object

Full Schema (JSON)

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-MedicationTreatmentLineMin.schema.json",
  "title": "Medication Treatment Line (Minimal)",
  "description": "Minimal medication treatment line payload for use within a QR code payload. Based on the IHE Pharmacy Medication Treatment Line logical model, with short element labels (one or two letters) and simple data types suitable for encoding in a compact QR code payload.",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "MedicationTreatmentLineMin",
      "description": "Resource type identifier for MedicationTreatmentLineMin logical model"
    },
    "@context": {
      "description": "JSON-LD context for this logical model with ValueSet vocabularies",
      "anyOf": [
        {
          "type": "string",
          "format": "uri",
          "description": "URI reference to external JSON-LD context"
        },
        {
          "type": "object",
          "description": "Inline JSON-LD context",
          "properties": {
            "@version": {
              "type": "number",
              "const": 1.1
            },
            "fhir": {
              "type": "string",
              "const": "http://hl7.org/fhir/"
            }
          },
          "additionalProperties": {
            "type": "string",
            "format": "uri"
          }
        },
        {
          "type": "array",
          "description": "Array of JSON-LD context objects/URIs",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "object"
              }
            ]
          }
        }
      ]
    },
    "@type": {
      "type": "string",
      "description": "JSON-LD type identifier for MedicationTreatmentLineMin logical model",
      "examples": [
        "LogicalModel-MedicationTreatmentLineMin"
      ]
    },
    "m": {
      "type": "string",
      "description": "Active ingredient of the medication."
    },
    "es": {
      "type": "string",
      "format": "date",
      "description": "Start date during which the medication treatment line is effective."
    },
    "ee": {
      "type": "string",
      "format": "date",
      "description": "End date during which the medication treatment line is effective."
    },
    "da": {
      "type": "string",
      "format": "date",
      "description": "Date the medication treatment line was asserted/recorded."
    },
    "d": {
      "type": "string",
      "description": "Dosage instructions as free text."
    },
    "r": {
      "type": "string",
      "description": "Reason why the product has been prescribed."
    },
    "a": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet medication-statement-status (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet medication-statement-status (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-medication-statement-status.jsonld",
              "description": "JSON-LD type reference to ValueSet medication-statement-status"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet medication-statement-status"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Status of patient adherence to the medication treatment line"
    }
  },
  "required": [
    "resourceType",
    "m"
  ],
  "resourceDefinition": "http://smart.who.int/ph4h/StructureDefinition/MedicationTreatmentLineMin",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "medication-statement-status"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "medication-statement-status": "http://smart.who.int/base/ValueSet-medication-statement-status.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationTreatmentLineMin 0..* Base Medication Treatment Line (Minimal)
... m 1..1 code Medication (Active Ingredient)
... es 0..1 date Effective Start Date
... ee 0..1 date Effective End Date
... d 0..1 string Dosage
... r 0..1 string Reason
... a 0..1 code Adherence Status
Binding: Medication Status Codes (extensible)

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationTreatmentLineMin.​a Base extensible Medication status codes 📦4.0.1 FHIR Std.

This structure is derived from Base

Summary

Mandatory: 0 element(1 nested mandatory element)

 

Other representations of profile: CSV, Excel