Australian Base Implementation Guide (AU Base 1)

This page is part of the Australian Base IG (v1.0.2: AU Base 1 on STU3) based on FHIR R3. This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

1.0 StructureDefinition-pbs-sponsor

PBS Manufacturer Organisation [FMM Level 2]

This extension applies to the Medication resource and is defining organisation administration details structure including core localisation concepts for use as a PBS sponsor in an Australian context. A PBS sponsor is an organisation with a PBS-assigned code responsible for the supply of medication.

Identifiers

These definitions represent common data held in the Organization.identifier element:

  • PBS Sponsor Identifier

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor

This extension applies to the Medication resource and is defining organisation administration details structure including core localisation concepts for use as a PBS sponsor in an Australian context. A PBS sponsor is an organisation with a PBS-assigned code responsible for the supply of medication.

This profile builds on Extension.

This profile was published on Wed Oct 03 00:00:00 AEST 2018 as a draft by Health Level Seven Australia (Medications WG).

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

This profile contains the following variations from Extension:

  1. url
    • value[x] (Reference as: au-pbs-sponsor)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*PBS sponsor
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor"
​... value[x] 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)
​.... identifier 1..1Identifier
​..... system 1..1uriPBS sponsor identifier URI
Fixed Value: http://pbs.gov.au/code/manufacturer
​..... value 1..1string
​.... display 0..1stringManufacturer supplier name of organisation

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*PBS sponsor
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor"
... valueReference 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)Value of extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriPBS sponsor identifier URI
Fixed Value: http://pbs.gov.au/code/manufacturer
..... value Σ1..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringManufacturer supplier name of organisation

doco Documentation for this format

This profile contains the following variations from Extension:

  1. url
    • value[x] (Reference as: au-pbs-sponsor)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..*PBS sponsor
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor"
​... value[x] 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)
​.... identifier 1..1Identifier
​..... system 1..1uriPBS sponsor identifier URI
Fixed Value: http://pbs.gov.au/code/manufacturer
​..... value 1..1string
​.... display 0..1stringManufacturer supplier name of organisation

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension I0..*PBS sponsor
... id 0..1stringxml:id (or equivalent in JSON)
... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
... url 1..1uri"http://hl7.org.au/fhir/StructureDefinition/pbs-sponsor"
... valueReference 0..1Reference(http://hl7.org.au/fhir/StructureDefinition/au-pbs-sponsor)Value of extension
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ1..1IdentifierLogical reference, when literal reference is not known
..... id 0..1stringxml:id (or equivalent in JSON)
..... extension 0..*ExtensionAdditional Content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ0..1codeusual | official | temp | secondary (If known)
Binding: IdentifierUse (required)
..... type Σ0..1CodeableConceptDescription of identifier
Binding: Identifier Type Codes (extensible)
..... system Σ1..1uriPBS sponsor identifier URI
Fixed Value: http://pbs.gov.au/code/manufacturer
..... value Σ1..1stringThe value that is unique
Example General': 123456
..... period Σ0..1PeriodTime period when id is/was valid for use
..... assigner Σ0..1Reference(Organization)Organization that issued id (may be just text)
.... display Σ0..1stringManufacturer supplier name of organisation

doco Documentation for this format

Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron

 

1.0.2 Quick Start

Below is an overview of the required search and read operations.

Summary of Search Criteria for StructureDefinition-pbs-sponsor

none defined