FHIR © HL7.org  |  Server Home  |  XIG Home  |  Server Source  |  FHIR  

FHIR IG Statistics: StructureDefinition/ModelMedicationRecordTreatmentLine

Packageihe-fhir-pharm-medicationrecord
TypeStructureDefinition
IdModelMedicationRecordTreatmentLine
FHIR VersionR5
Sourcehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/https://build.fhir.org/ig/IHE/pharm-medo/StructureDefinition-ModelMedicationRecordTreatmentLine.html
URLhttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine
Version0.1.0
Statusactive
Date2023-03-27T10:17:54+00:00
NameModelMedicationRecordTreatmentLine
TitleMedication Record Treatment Line - logical model
Realmuv
Authorityihe
DescriptionA model for representing a Treatment Line.
CopyrightIHE http://www.ihe.net/Governance/#Intellectual_Property
Typehttp://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine
Kindlogical

Resources that use this resource

StructureDefinition
ModelMedicationRecordMedication Record logical model

Resources that this resource uses

StructureDefinition
ModelMedicationRecordTreatmentMedication Record - Medication Treatment

Narrative

Note: links and images are rebased to the (stated) source

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModelMedicationRecordTreatmentLine 0..*BaseMedication Record Treatment Line - logical model
... identifier 0..1IdentifierThe business identifier(s) for the medication treatment Line
... basedOn 0..1Reference(Medication Record - Medication Treatment)The identifier of the treatment from which this line stems
... subject 1..1Reference(Patient)For whom this treatment line was created
... recorder 1..1Reference(Practitioner | Organization)Who created this treatment line
... recordDate 1..1dateTimeDatetime that the treatment line was created or updated
... startMedicationDate 1..1dateTimeStart date of the medication
... endMedicationDate 0..1dateTimeEnd date, if exists, for stopping the medication
... originType 1..1CodeableConceptFrom what context this treatment line stems
... reaction 0..*CodeableConceptReaction to this treatment line
... product[x] 1..1Product for which the treatment line refers to
.... productCodeableConceptCodeableConcept
.... productReferenceReference(Medication)
... medicationType 0..*CodeableConceptWhat type of medication the product is: hospital, community, preparation, etc
... instructionForUse 0..*stringFull representation of the dosage instructions
... dosageAmount 0..1CodeableConceptQuantity to be consumed
... periodicity 0..1CodeableConceptScheduling for the consumption
... route 1..1CodeableConceptRoute through which the product should consumed
... dayPeriod 0..*CodeableConceptPeriod of the day for consuming the product
... lifecycleStatus 1..1CodeableConceptStatus of the treatment line
... statusReason 0..*CodeableConceptReason the status
... treatmentPlan 0..1Reference()Link to the 'parent' treatment - i.e the treatment that this order is derived from, or contriburing to
... indication 0..*CodeableConceptWhy the treatment exists

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ModelMedicationRecordTreatmentLine",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine",
  "version": "0.1.0",
  "name": "ModelMedicationRecordTreatmentLine",
  "title": "Medication Record Treatment Line - logical model",
  "status": "active",
  "date": "2023-03-27T10:17:54+00:00",
  "publisher": "Integrating the Healthcare Enterprise (IHE)",
  "contact": [
    {
      "name": "Integrating the Healthcare Enterprise (IHE)",
      "telecom": [
        {
          "system": "url",
          "value": "http://ihe.net"
        },
        {
          "system": "email",
          "value": "secretary@ihe.net"
        }
      ]
    },
    {
      "name": "Jose Costa Teixeira",
      "telecom": [
        {
          "system": "email",
          "value": "jose.a.teixeira@gmail.com",
          "use": "work"
        }
      ]
    }
  ],
  "description": "A model for representing a Treatment Line.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "001"
        }
      ]
    }
  ],
  "copyright": "IHE http://www.ihe.net/Governance/#Intellectual_Property",
  "fhirVersion": "5.0.0",
  "mapping": [
    {
      "identity": "rim",
      "uri": "http://hl7.org/v3",
      "name": "RIM Mapping"
    }
  ],
  "kind": "logical",
  "abstract": false,
  "type": "http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatmentLine",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "ModelMedicationRecordTreatmentLine",
        "path": "ModelMedicationRecordTreatmentLine",
        "short": "Medication Record Treatment Line - logical model",
        "definition": "A model for representing a Treatment Line.",
        "min": 0,
        "max": "*",
        "base": {
          "path": "Base",
          "min": 0,
          "max": "*"
        },
        "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"
          }
        ],
        "isModifier": false,
        "mapping": [
          {
            "identity": "rim",
            "map": "n/a"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.identifier",
        "path": "ModelMedicationRecordTreatmentLine.identifier",
        "short": "The business identifier(s) for the medication treatment Line",
        "definition": "The business identifier(s) for the medication treatment Line",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.identifier",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.basedOn",
        "path": "ModelMedicationRecordTreatmentLine.basedOn",
        "short": "The identifier of the treatment from which this line stems",
        "definition": "The identifier of the treatment from which this line stems",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.basedOn",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.subject",
        "path": "ModelMedicationRecordTreatmentLine.subject",
        "short": "For whom this treatment line was created",
        "definition": "For whom this treatment line was created",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.subject",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.recorder",
        "path": "ModelMedicationRecordTreatmentLine.recorder",
        "short": "Who created this treatment line",
        "definition": "Who created this treatment line",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.recorder",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.recordDate",
        "path": "ModelMedicationRecordTreatmentLine.recordDate",
        "short": "Datetime that the treatment line was created or updated",
        "definition": "Datetime that the treatment line was created or updated",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.recordDate",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.startMedicationDate",
        "path": "ModelMedicationRecordTreatmentLine.startMedicationDate",
        "short": "Start date of the medication",
        "definition": "Start date of the medication",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.startMedicationDate",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.endMedicationDate",
        "path": "ModelMedicationRecordTreatmentLine.endMedicationDate",
        "short": "End date, if exists, for stopping the medication",
        "definition": "End date, if exists, for stopping the medication",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.endMedicationDate",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.originType",
        "path": "ModelMedicationRecordTreatmentLine.originType",
        "short": "From what context this treatment line stems",
        "definition": "From what context this treatment line stems, whether is ambulatory prescription, patient request, etc",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.originType",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.reaction",
        "path": "ModelMedicationRecordTreatmentLine.reaction",
        "short": "Reaction to this treatment line",
        "definition": "Reaction to this treatment line",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.reaction",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.product[x]",
        "path": "ModelMedicationRecordTreatmentLine.product[x]",
        "short": "Product for which the treatment line refers to",
        "definition": "Product for which the treatment line refers to",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.product[x]",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          },
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Medication"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.medicationType",
        "path": "ModelMedicationRecordTreatmentLine.medicationType",
        "short": "What type of medication the product is: hospital, community, preparation, etc",
        "definition": "What type of medication the product is: hospital, community, preparation, etc",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.medicationType",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.instructionForUse",
        "path": "ModelMedicationRecordTreatmentLine.instructionForUse",
        "short": "Full representation of the dosage instructions",
        "definition": "Full representation of the dosage instructions",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.instructionForUse",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.dosageAmount",
        "path": "ModelMedicationRecordTreatmentLine.dosageAmount",
        "short": "Quantity to be consumed",
        "definition": "Quantity to be consumed",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.dosageAmount",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.periodicity",
        "path": "ModelMedicationRecordTreatmentLine.periodicity",
        "short": "Scheduling for the consumption",
        "definition": "Scheduling for the consumption",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.periodicity",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.route",
        "path": "ModelMedicationRecordTreatmentLine.route",
        "short": "Route through which the product should consumed",
        "definition": "Route through which the product should consumed",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.route",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.dayPeriod",
        "path": "ModelMedicationRecordTreatmentLine.dayPeriod",
        "short": "Period of the day for consuming the product",
        "definition": "Period of the day for consuming the product",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.dayPeriod",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.lifecycleStatus",
        "path": "ModelMedicationRecordTreatmentLine.lifecycleStatus",
        "short": "Status of the treatment line",
        "definition": "Status of the treatment line",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.lifecycleStatus",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.statusReason",
        "path": "ModelMedicationRecordTreatmentLine.statusReason",
        "short": "Reason the status",
        "definition": "Reason the status",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.statusReason",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.treatmentPlan",
        "path": "ModelMedicationRecordTreatmentLine.treatmentPlan",
        "short": "Link to the 'parent' treatment - i.e the treatment that this order is derived from, or contriburing to",
        "definition": "Link to the 'parent' treatment - i.e the treatment that this order is derived from, or contriburing to",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.treatmentPlan",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.indication",
        "path": "ModelMedicationRecordTreatmentLine.indication",
        "short": "Why the treatment exists",
        "definition": "Why the treatment exists",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatmentLine.indication",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ModelMedicationRecordTreatmentLine",
        "path": "ModelMedicationRecordTreatmentLine",
        "short": "Medication Record Treatment Line - logical model",
        "definition": "A model for representing a Treatment Line."
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.identifier",
        "path": "ModelMedicationRecordTreatmentLine.identifier",
        "short": "The business identifier(s) for the medication treatment Line",
        "definition": "The business identifier(s) for the medication treatment Line",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.basedOn",
        "path": "ModelMedicationRecordTreatmentLine.basedOn",
        "short": "The identifier of the treatment from which this line stems",
        "definition": "The identifier of the treatment from which this line stems",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.subject",
        "path": "ModelMedicationRecordTreatmentLine.subject",
        "short": "For whom this treatment line was created",
        "definition": "For whom this treatment line was created",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.recorder",
        "path": "ModelMedicationRecordTreatmentLine.recorder",
        "short": "Who created this treatment line",
        "definition": "Who created this treatment line",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/Organization"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.recordDate",
        "path": "ModelMedicationRecordTreatmentLine.recordDate",
        "short": "Datetime that the treatment line was created or updated",
        "definition": "Datetime that the treatment line was created or updated",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.startMedicationDate",
        "path": "ModelMedicationRecordTreatmentLine.startMedicationDate",
        "short": "Start date of the medication",
        "definition": "Start date of the medication",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.endMedicationDate",
        "path": "ModelMedicationRecordTreatmentLine.endMedicationDate",
        "short": "End date, if exists, for stopping the medication",
        "definition": "End date, if exists, for stopping the medication",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.originType",
        "path": "ModelMedicationRecordTreatmentLine.originType",
        "short": "From what context this treatment line stems",
        "definition": "From what context this treatment line stems, whether is ambulatory prescription, patient request, etc",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.reaction",
        "path": "ModelMedicationRecordTreatmentLine.reaction",
        "short": "Reaction to this treatment line",
        "definition": "Reaction to this treatment line",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.product[x]",
        "path": "ModelMedicationRecordTreatmentLine.product[x]",
        "short": "Product for which the treatment line refers to",
        "definition": "Product for which the treatment line refers to",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          },
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Medication"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.medicationType",
        "path": "ModelMedicationRecordTreatmentLine.medicationType",
        "short": "What type of medication the product is: hospital, community, preparation, etc",
        "definition": "What type of medication the product is: hospital, community, preparation, etc",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.instructionForUse",
        "path": "ModelMedicationRecordTreatmentLine.instructionForUse",
        "short": "Full representation of the dosage instructions",
        "definition": "Full representation of the dosage instructions",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.dosageAmount",
        "path": "ModelMedicationRecordTreatmentLine.dosageAmount",
        "short": "Quantity to be consumed",
        "definition": "Quantity to be consumed",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.periodicity",
        "path": "ModelMedicationRecordTreatmentLine.periodicity",
        "short": "Scheduling for the consumption",
        "definition": "Scheduling for the consumption",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.route",
        "path": "ModelMedicationRecordTreatmentLine.route",
        "short": "Route through which the product should consumed",
        "definition": "Route through which the product should consumed",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.dayPeriod",
        "path": "ModelMedicationRecordTreatmentLine.dayPeriod",
        "short": "Period of the day for consuming the product",
        "definition": "Period of the day for consuming the product",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.lifecycleStatus",
        "path": "ModelMedicationRecordTreatmentLine.lifecycleStatus",
        "short": "Status of the treatment line",
        "definition": "Status of the treatment line",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.statusReason",
        "path": "ModelMedicationRecordTreatmentLine.statusReason",
        "short": "Reason the status",
        "definition": "Reason the status",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.treatmentPlan",
        "path": "ModelMedicationRecordTreatmentLine.treatmentPlan",
        "short": "Link to the 'parent' treatment - i.e the treatment that this order is derived from, or contriburing to",
        "definition": "Link to the 'parent' treatment - i.e the treatment that this order is derived from, or contriburing to",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatmentLine.indication",
        "path": "ModelMedicationRecordTreatmentLine.indication",
        "short": "Why the treatment exists",
        "definition": "Why the treatment exists",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      }
    ]
  }
}