PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.au.base@5.0.0
    http://hl7.org.au/fhir/StructureDefinition/medication-brand-name
{
  "description": "This extension applies to the Medication, MedicationRequest, MedicationDispense and MedicationStatement resources and is used to represent the brand name of a medication. This extension is not to be the sole representation of the medication concept; it shall not be used as a substitute for medication code (e.g. Medication.code or MedicationStatement.medicationCodeableConcept).\\n\\nIf a system can only supply branded product information in text form, that information will be supplied in the text portion of that code e.g. code.text or medicationCodeableConcept.text. This extension only supports the name portion of a medication concept, not the branded product or product pack information. It is available for use for where a system needs to separate out the brand name string for handling or other processing.",
  "_filename": "StructureDefinition-medication-brand-name.json",
  "package_name": "hl7.fhir.au.base",
  "date": "2025-01-15T23:49:19+00:00",
  "derivation": "constraint",
  "publisher": "HL7 Australia",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "AU",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "MedicationBrandName",
  "mapping": [ {
    "uri": "http://hl7.org/v3",
    "name": "RIM Mapping",
    "identity": "rim"
  } ],
  "abstract": false,
  "copyright": "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.",
  "type": "Extension",
  "experimental": null,
  "resourceType": "StructureDefinition",
  "title": "Medication Brand Name",
  "package_version": "5.0.0",
  "extension": [ {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger": 1
  }, {
    "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode": "trial-use",
    "_valueCode": {
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical": "http://hl7.org.au/fhir/ImplementationGuide/hl7.fhir.au.base"
      } ]
    }
  } ],
  "snapshot": {
    "element": [ {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Extension",
      "min": 0,
      "definition": "The brand medication text name for an associated medication, this may be supplied if a coded brand name is not available.",
      "isModifier": false,
      "short": "Medication brand name",
      "max": "1",
      "id": "Extension",
      "condition": [ "ele-1" ],
      "base": {
        "max": "*",
        "min": 0,
        "path": "Extension"
      }
    }, {
      "path": "Extension.id",
      "min": 0,
      "definition": "Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.",
      "isModifier": false,
      "short": "Unique id for inter-element referencing",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "string"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Extension.id",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Element.id"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      }, {
        "key": "ext-1",
        "human": "Must have either extensions or value[x], not both",
        "xpath": "exists(f:extension)!=exists(f:*[starts-with(local-name(.), \"value\")])",
        "source": "http://hl7.org/fhir/StructureDefinition/Extension",
        "severity": "error",
        "expression": "extension.exists() != value.exists()"
      } ],
      "path": "Extension.extension",
      "min": 0,
      "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 manageable, 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.",
      "isModifier": false,
      "short": "Additional content defined by implementations",
      "mapping": [ {
        "map": "n/a",
        "identity": "rim"
      } ],
      "slicing": {
        "rules": "open",
        "description": "Extensions are always sliced by (at least) url",
        "discriminator": [ {
          "path": "url",
          "type": "value"
        } ]
      },
      "type": [ {
        "code": "Extension"
      } ],
      "alias": [ "extensions", "user content" ],
      "max": "*",
      "id": "Extension.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.",
      "base": {
        "max": "*",
        "min": 0,
        "path": "Element.extension"
      },
      "isSummary": false
    }, {
      "path": "Extension.url",
      "min": 1,
      "definition": "Source of the definition for the extension code - a logical name or a URL.",
      "isModifier": false,
      "short": "identifies the meaning of the extension",
      "fixedUri": "http://hl7.org.au/fhir/StructureDefinition/medication-brand-name",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "http://hl7.org/fhirpath/System.String",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fhir-type",
          "valueUrl": "uri"
        } ]
      } ],
      "representation": [ "xmlAttr" ],
      "max": "1",
      "id": "Extension.url",
      "comment": "The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.",
      "base": {
        "max": "1",
        "min": 1,
        "path": "Extension.url"
      },
      "isSummary": false
    }, {
      "constraint": [ {
        "key": "ele-1",
        "human": "All FHIR elements must have a @value or children",
        "xpath": "@value|f:*|h:div",
        "source": "http://hl7.org/fhir/StructureDefinition/Element",
        "severity": "error",
        "expression": "hasValue() or (children().count() > id.count())"
      } ],
      "path": "Extension.value[x]",
      "min": 1,
      "definition": "Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).",
      "isModifier": false,
      "short": "Brand or product name",
      "mapping": [ {
        "map": "N/A",
        "identity": "rim"
      } ],
      "type": [ {
        "code": "string"
      } ],
      "max": "1",
      "id": "Extension.value[x]",
      "base": {
        "max": "1",
        "min": 0,
        "path": "Extension.value[x]"
      },
      "isSummary": false
    } ]
  },
  "status": "active",
  "id": "882a088f-5981-4adf-ab5c-f60bc2718559",
  "kind": "complex-type",
  "url": "http://hl7.org.au/fhir/StructureDefinition/medication-brand-name",
  "context": [ {
    "type": "element",
    "expression": "Medication"
  }, {
    "type": "element",
    "expression": "MedicationRequest"
  }, {
    "type": "element",
    "expression": "MedicationDispense"
  }, {
    "type": "element",
    "expression": "MedicationStatement"
  } ],
  "version": "5.0.0",
  "differential": {
    "element": [ {
      "id": "Extension",
      "max": "1",
      "path": "Extension",
      "short": "Medication brand name",
      "definition": "The brand medication text name for an associated medication, this may be supplied if a coded brand name is not available."
    }, {
      "id": "Extension.url",
      "path": "Extension.url",
      "fixedUri": "http://hl7.org.au/fhir/StructureDefinition/medication-brand-name"
    }, {
      "id": "Extension.value[x]",
      "min": 1,
      "path": "Extension.value[x]",
      "type": [ {
        "code": "string"
      } ],
      "short": "Brand or product name"
    } ]
  },
  "contact": [ {
    "name": "HL7 Australia FHIR Working Group",
    "telecom": [ {
      "use": "work",
      "value": "https://confluence.hl7.org/display/HAFWG",
      "system": "url"
    } ]
  } ],
  "baseDefinition": "http://hl7.org/fhir/StructureDefinition/Extension"
}