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

FHIR IG Statistics: StructureDefinition/ModelMedicationRecordTreatment

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

Resources that use this resource

StructureDefinition
ModelMedicationRecordMedication Record logical model
ModelMedicationRecordTreatmentLineMedication Record Treatment Line - logical model

Resources that this resource uses

No resources found


Narrative

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ModelMedicationRecordTreatment 0..*BaseMedication Record - Medication Treatment
... identifier 0..1BackboneElementThe business identifier(s) for the medication treatment
.... treatmentGuid 0..1IdentifierThe Global Unique identifier(s) for the medication treatment
... subject 1..1Reference(Patient)The subject of the medication treatment
... status 1..1codeStatus of the medication treatment
... intent 1..1code
... category 0..*CodeableConceptCategory(ies) of the medication treatment
... title 0..1stringShort title of the medication treatment
... description 0..1stringTextual description of the treatment
... encounter 0..1Reference(Encounter)The encounter in which the medication treatment was created or updated
... period 0..1PeriodThe duration of the treatment
... created 0..1dateTimeWhen the treatment record was created
... author 0..1Reference(Patient | Practitioner | PractitionerRole | Device | RelatedPerson | Organization | CareTeam)The current author/responsible for the medication treatment plan
... note 0..*AnnotationComments about the plan

doco Documentation for this format

Source

{
  "resourceType": "StructureDefinition",
  "id": "ModelMedicationRecordTreatment",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://profiles.ihe.net/PHARM/ihe.pharm.medicationrecord/StructureDefinition/ModelMedicationRecordTreatment",
  "version": "0.1.0",
  "name": "ModelMedicationRecordTreatment",
  "title": "Medication Record - Medication Treatment",
  "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 the Medication Treatment.",
  "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/ModelMedicationRecordTreatment",
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
  "derivation": "specialization",
  "snapshot": {
    "element": [
      {
        "id": "ModelMedicationRecordTreatment",
        "path": "ModelMedicationRecordTreatment",
        "short": "Medication Record - Medication Treatment",
        "definition": "A model for the Medication Treatment.",
        "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": "ModelMedicationRecordTreatment.identifier",
        "path": "ModelMedicationRecordTreatment.identifier",
        "short": "The business identifier(s) for the medication treatment",
        "definition": "The business identifier(s) for the medication treatment",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.identifier",
          "min": 0,
          "max": "1"
        },
        "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": "ModelMedicationRecordTreatment.identifier.id",
        "path": "ModelMedicationRecordTreatment.identifier.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": "ModelMedicationRecordTreatment.identifier.extension",
        "path": "ModelMedicationRecordTreatment.identifier.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": "ModelMedicationRecordTreatment.identifier.modifierExtension",
        "path": "ModelMedicationRecordTreatment.identifier.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/5.0.0-snapshot3/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": "ModelMedicationRecordTreatment.identifier.treatmentGuid",
        "path": "ModelMedicationRecordTreatment.identifier.treatmentGuid",
        "short": "The Global Unique identifier(s) for the medication treatment",
        "definition": "The Global Unique identifier(s) for the medication treatment",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.identifier.treatmentGuid",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.subject",
        "path": "ModelMedicationRecordTreatment.subject",
        "short": "The subject of the medication treatment",
        "definition": "The subject of the medication treatment",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.subject",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.status",
        "path": "ModelMedicationRecordTreatment.status",
        "short": "Status of the medication treatment",
        "definition": "Status of the medication treatment",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.status",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.intent",
        "path": "ModelMedicationRecordTreatment.intent",
        "min": 1,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.intent",
          "min": 1,
          "max": "1"
        },
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.category",
        "path": "ModelMedicationRecordTreatment.category",
        "short": "Category(ies) of the medication treatment",
        "definition": "Category(ies) of the medication treatment",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatment.category",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.title",
        "path": "ModelMedicationRecordTreatment.title",
        "short": "Short title of the medication treatment",
        "definition": "Short title of the medication treatment",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.title",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.description",
        "path": "ModelMedicationRecordTreatment.description",
        "short": "Textual description of the treatment",
        "definition": "Textual description of the medication treatment",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.description",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.encounter",
        "path": "ModelMedicationRecordTreatment.encounter",
        "short": "The encounter in which the medication treatment was created or updated",
        "definition": "The encounter in which the medication treatment was created or updated",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.encounter",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Encounter"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.period",
        "path": "ModelMedicationRecordTreatment.period",
        "short": "The duration of the treatment",
        "definition": "The duration of the treatment",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.period",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.created",
        "path": "ModelMedicationRecordTreatment.created",
        "short": "When the treatment record was created",
        "definition": "When the treatment record was created",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.created",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.author",
        "path": "ModelMedicationRecordTreatment.author",
        "short": "The current author/responsible for the medication treatment plan",
        "definition": "The current author/responsible for the medication treatment plan",
        "min": 0,
        "max": "1",
        "base": {
          "path": "ModelMedicationRecordTreatment.author",
          "min": 0,
          "max": "1"
        },
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Device",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/Organization",
              "http://hl7.org/fhir/StructureDefinition/CareTeam"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.note",
        "path": "ModelMedicationRecordTreatment.note",
        "short": "Comments about the plan",
        "definition": "Comments about the plan",
        "min": 0,
        "max": "*",
        "base": {
          "path": "ModelMedicationRecordTreatment.note",
          "min": 0,
          "max": "*"
        },
        "type": [
          {
            "code": "Annotation"
          }
        ]
      }
    ]
  },
  "differential": {
    "element": [
      {
        "id": "ModelMedicationRecordTreatment",
        "path": "ModelMedicationRecordTreatment",
        "short": "Medication Record - Medication Treatment",
        "definition": "A model for the Medication Treatment."
      },
      {
        "id": "ModelMedicationRecordTreatment.identifier",
        "path": "ModelMedicationRecordTreatment.identifier",
        "short": "The business identifier(s) for the medication treatment",
        "definition": "The business identifier(s) for the medication treatment",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "BackboneElement"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.identifier.treatmentGuid",
        "path": "ModelMedicationRecordTreatment.identifier.treatmentGuid",
        "short": "The Global Unique identifier(s) for the medication treatment",
        "definition": "The Global Unique identifier(s) for the medication treatment",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Identifier"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.subject",
        "path": "ModelMedicationRecordTreatment.subject",
        "short": "The subject of the medication treatment",
        "definition": "The subject of the medication treatment",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.status",
        "path": "ModelMedicationRecordTreatment.status",
        "short": "Status of the medication treatment",
        "definition": "Status of the medication treatment",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.intent",
        "path": "ModelMedicationRecordTreatment.intent",
        "min": 1,
        "max": "1",
        "type": [
          {
            "code": "code"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.category",
        "path": "ModelMedicationRecordTreatment.category",
        "short": "Category(ies) of the medication treatment",
        "definition": "Category(ies) of the medication treatment",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "CodeableConcept"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.title",
        "path": "ModelMedicationRecordTreatment.title",
        "short": "Short title of the medication treatment",
        "definition": "Short title of the medication treatment",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.description",
        "path": "ModelMedicationRecordTreatment.description",
        "short": "Textual description of the treatment",
        "definition": "Textual description of the medication treatment",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "string"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.encounter",
        "path": "ModelMedicationRecordTreatment.encounter",
        "short": "The encounter in which the medication treatment was created or updated",
        "definition": "The encounter in which the medication treatment was created or updated",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Encounter"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.period",
        "path": "ModelMedicationRecordTreatment.period",
        "short": "The duration of the treatment",
        "definition": "The duration of the treatment",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Period"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.created",
        "path": "ModelMedicationRecordTreatment.created",
        "short": "When the treatment record was created",
        "definition": "When the treatment record was created",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "dateTime"
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.author",
        "path": "ModelMedicationRecordTreatment.author",
        "short": "The current author/responsible for the medication treatment plan",
        "definition": "The current author/responsible for the medication treatment plan",
        "min": 0,
        "max": "1",
        "type": [
          {
            "code": "Reference",
            "targetProfile": [
              "http://hl7.org/fhir/StructureDefinition/Patient",
              "http://hl7.org/fhir/StructureDefinition/Practitioner",
              "http://hl7.org/fhir/StructureDefinition/PractitionerRole",
              "http://hl7.org/fhir/StructureDefinition/Device",
              "http://hl7.org/fhir/StructureDefinition/RelatedPerson",
              "http://hl7.org/fhir/StructureDefinition/Organization",
              "http://hl7.org/fhir/StructureDefinition/CareTeam"
            ]
          }
        ]
      },
      {
        "id": "ModelMedicationRecordTreatment.note",
        "path": "ModelMedicationRecordTreatment.note",
        "short": "Comments about the plan",
        "definition": "Comments about the plan",
        "min": 0,
        "max": "*",
        "type": [
          {
            "code": "Annotation"
          }
        ]
      }
    ]
  }
}