Magentus Practice Management FHIR Implementation Guide - Local Development build (v1.2.60) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

• Narrative Content
• JSON

: Get Brands Operation - JSON Representation

Active as of 2026-04-03

Raw json | Download

{
  "resourceType" : "OperationDefinition",
  "id" : "EOrderGetBrandsOperation",
  "text" : {
    "status" : "generated",
    "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: OperationDefinition EOrderGetBrandsOperation</b></p><a name=\"EOrderGetBrandsOperation\"> </a><a name=\"hcEOrderGetBrandsOperation\"> </a><p>URL: [base]/Organization/$get_brands</p><h3>Parameters</h3><table class=\"grid\"><tr><td><b>Use</b></td><td><b>Name</b></td><td><b>Scope</b></td><td><b>Cardinality</b></td><td><b>Type</b></td><td><b>Binding</b></td><td><b>Documentation</b></td></tr><tr><td>IN</td><td>serviceType</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/datatypes.html#code\">code</a></td><td><a href=\"ValueSet-eorder-brand-service-type-valueset.html\">Brand Service Type ValueSet</a> (Required)</td><td><div><p>Optional filter to restrict results to a specific service type. Use 'pathology' for pathology laboratories or 'imaging' for imaging services. If not provided, both types are returned.</p>\n</div></td></tr><tr><td>IN</td><td>parentOrganization</td><td/><td>0..1</td><td><a href=\"http://hl7.org/fhir/R4/references.html#Reference\">Reference</a> (<a href=\"StructureDefinition-eorders-organization-diagnostic-parent.html\" title=\"http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-diagnostic-parent\">eOrders Organisation Diagnostic Parent</a>)</td><td/><td><div><p>Optional filter to restrict results to brands belonging to a specific diagnostic parent organization.</p>\n</div></td></tr><tr><td>OUT</td><td>brand</td><td/><td>0..*</td><td><a href=\"http://hl7.org/fhir/R4/organization.html\">Organization</a></td><td/><td><div><p>A brand organization.</p>\n</div></td></tr></table></div>"
  },
  "url" : "http://fhir.geniesolutions.io/OperationDefinition/EOrderGetBrandsOperation",
  "version" : "1.2.60",
  "name" : "EOrderGetBrandsOperation",
  "title" : "Get Brands Operation",
  "status" : "active",
  "kind" : "operation",
  "date" : "2026-04-03",
  "publisher" : "Magentus Practice Management",
  "contact" : [
    {
      "name" : "Magentus Practice Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.magentus.com/practice-management"
        },
        {
          "system" : "email",
          "value" : "andy.bond@magentus.com"
        }
      ]
    },
    {
      "name" : "Magentus Practice Management",
      "telecom" : [
        {
          "system" : "url",
          "value" : "https://www.magentus.com/practice-management",
          "use" : "work"
        }
      ]
    }
  ],
  "description" : "This operation returns a list of diagnostic service brand Organizations (EOrdersOrganizationPathologyLaboratory and EOrdersOrganizationImagingService). This allows clients to discover available diagnostic service providers.",
  "jurisdiction" : [
    {
      "coding" : [
        {
          "system" : "urn:iso:std:iso:3166",
          "code" : "AU"
        }
      ]
    }
  ],
  "code" : "get_brands",
  "resource" : [
    "Organization"
  ],
  "system" : false,
  "type" : true,
  "instance" : false,
  "parameter" : [
    {
      "name" : "serviceType",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional filter to restrict results to a specific service type. Use 'pathology' for pathology laboratories or 'imaging' for imaging services. If not provided, both types are returned.",
      "type" : "code",
      "binding" : {
        "strength" : "required",
        "valueSet" : "http://fhir.geniesolutions.io/ValueSet/eorder-brand-service-type-valueset"
      }
    },
    {
      "name" : "parentOrganization",
      "use" : "in",
      "min" : 0,
      "max" : "1",
      "documentation" : "Optional filter to restrict results to brands belonging to a specific diagnostic parent organization.",
      "type" : "Reference",
      "targetProfile" : [
        🔗 "http://fhir.geniesolutions.io/StructureDefinition/eorders-organization-diagnostic-parent"
      ]
    },
    {
      "name" : "brand",
      "use" : "out",
      "min" : 0,
      "max" : "*",
      "documentation" : "A brand organization.",
      "type" : "Organization"
    }
  ]
}