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 Overview (Minimal)

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

Minimal medication overview payload for use within a QR code payload. Based on the IHE Pharmacy Medication Overview logical model, with short element labels (one or two letters) and simple data

Usages:

  • This Logical Model is not used by any profiles in this Specification

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
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3

API Information

Medication Overview (Minimal) API

Minimal medication overview payload for use within a QR code payload. Based on the IHE Pharmacy Medication Overview logical model, with short element labels (one or two letters) and simple data

Version: 1.0.0

Endpoints

GET /StructureDefinition-MedicationOverviewMin.schema.json

JSON Schema definition for the Logical Model StructureDefinition-MedicationOverviewMin

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

Schema Definition

StructureDefinition-MedicationOverviewMin

Description: Minimal medication overview payload for use within a QR code payload. Based on the IHE Pharmacy Medication Overview logical model, with short element labels (one or two letters) and simple data

Type: object

Full Schema (JSON) 

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "http://smart.who.int/base/StructureDefinition-MedicationOverviewMin.schema.json",
  "title": "Medication Overview (Minimal)",
  "description": "Minimal medication overview payload for use within a QR code payload. Based on the IHE Pharmacy Medication Overview logical model, with short element labels (one or two letters) and simple data",
  "type": "object",
  "properties": {
    "resourceType": {
      "type": "string",
      "const": "MedicationOverviewMin",
      "description": "Resource type identifier for MedicationOverviewMin 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 MedicationOverviewMin logical model",
      "examples": [
        "LogicalModel-MedicationOverviewMin"
      ]
    },
    "n": {
      "type": "string",
      "description": "Patient Name"
    },
    "dob": {
      "type": "string",
      "format": "date",
      "description": "Patient Date of Birth"
    },
    "s": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet administrative-gender (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet administrative-gender (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-administrative-gender.jsonld",
              "description": "JSON-LD type reference to ValueSet administrative-gender"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet administrative-gender"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Sex"
    },
    "nt": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet iso3166-1-3 (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet iso3166-1-3 (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-iso3166-1-3.jsonld",
              "description": "JSON-LD type reference to ValueSet iso3166-1-3"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet iso3166-1-3"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Nationality"
    },
    "id": {
      "type": "string",
      "description": "National Identifier"
    },
    "dt": {
      "oneOf": [
        {
          "type": "string",
          "description": "Code from ValueSet v2-0203 (plain string)"
        },
        {
          "type": "object",
          "description": "Code from ValueSet v2-0203 (JSON-LD structure)",
          "properties": {
            "@type": {
              "type": "string",
              "const": "http://smart.who.int/base/ValueSet-v2-0203.jsonld",
              "description": "JSON-LD type reference to ValueSet v2-0203"
            },
            "@id": {
              "type": "string",
              "format": "uri",
              "description": "Full IRI of the code from ValueSet v2-0203"
            }
          },
          "required": [
            "@type",
            "@id"
          ],
          "additionalProperties": false
        }
      ],
      "description": "Type of national identifier (e.g., social security number, national health ID, etc.)"
    },
    "m": {
      "type": "array",
      "items": {
        "$ref": "http://smart.who.int/base/StructureDefinition-MedicationTreatmentLineMin.schema.json"
      },
      "description": "List of medication treatment lines associated with the patient, represented in a minimal format suitable for encoding in a compact QR code payload."
    }
  },
  "required": [
    "resourceType",
    "n",
    "dob",
    "s"
  ],
  "resourceDefinition": "http://smart.who.int/ph4h/StructureDefinition/MedicationOverviewMin",
  "fhir:parent": "http://hl7.org/fhir/StructureDefinition/Base",
  "jsonld:valuesets": [
    "iso3166-1-3",
    "administrative-gender",
    "v2-0203"
  ],
  "jsonld:contextTemplate": {
    "@version": 1.1,
    "fhir": "http://hl7.org/fhir/",
    "iso3166-1-3": "http://smart.who.int/base/ValueSet-iso3166-1-3.jsonld",
    "administrative-gender": "http://smart.who.int/base/ValueSet-administrative-gender.jsonld",
    "v2-0203": "http://smart.who.int/base/ValueSet-v2-0203.jsonld"
  }
}

This documentation is automatically generated from the OpenAPI specification.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. MedicationOverviewMin C 0..* Base Medication Overview (Minimal)
Constraints: MedicationOverviewMin-TreatmentLines
... n 1..1 string Patient Name
... dob 1..1 date Patient Date of Birth
... s 1..1 code Sex
Binding: AdministrativeGender (extensible)
... id 0..1 string National Identifier
... dt 0..1 code National Identifier Type
Binding: hl7VS-identifierType (extensible)
... m 0..* MedicationTreatmentLineMin Medication Treatment Lines

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
MedicationOverviewMin.​s Base extensible AdministrativeGender 📦4.0.1 FHIR Std.
MedicationOverviewMin.​nt Base extensible Iso 3166 Part 1: 3 Letter Codes 📦4.0.1 FHIR Std.
MedicationOverviewMin.​dt Base extensible hl7VS-identifierType 📦3.0.0 THO v7.2

Constraints

Id Grade Path(s) Description Expression
MedicationOverviewMin-TreatmentLines error MedicationOverviewMin If more than one medication treatment line is present, there can be a maximum of 3 medication treatment lines to ensure the overall payload remains compact enough for encoding in a QR code. m.count() <= 3

This structure is derived from Base

Summary

Mandatory: 0 element(3 nested mandatory elements)

 

Other representations of profile: CSV, Excel