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-organisation

PBS Sponsor Organisation [FMM Level 2]

This profile is suitable for representing PBS sponsor organisation administration details. 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 - PBS assigned two letter code referencing a drug manufacturer/sponsor organisation.

1.0.1 Formal Views of Profile Content

The official URL for this profile is: 

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

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 Organization.

This profile was published on Thu Apr 25 00:00:00 AEST 2019 as a active 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 Organization:

  1. identifier PBS Sponsor identifiers sliced
    • identifier PBS Sponsor Identifier
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*A PBS sponsor for medications in an Australian healthcare context
... identifier IdentifierPBS Sponsor identifiers
Slice: Unordered, Open by value:system
... identifier 1..1IdentifierPBS Sponsor Identifier
.... system 1..1uriPBS sponsor
Fixed Value: http://hl7.org.au/id/pbs-sponsor
.... value 1..1string

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A PBS sponsor for medications in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIIdentifierPBS Sponsor identifiers
Slice: Unordered, Open by value:system
... identifier ΣI1..1IdentifierPBS Sponsor Identifier
.... 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
Fixed Value: http://hl7.org.au/id/pbs-sponsor
.... 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)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

doco Documentation for this format

This profile contains the following variations from Organization:

  1. identifier PBS Sponsor identifiers sliced
    • identifier PBS Sponsor Identifier

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*A PBS sponsor for medications in an Australian healthcare context
... identifier IdentifierPBS Sponsor identifiers
Slice: Unordered, Open by value:system
... identifier 1..1IdentifierPBS Sponsor Identifier
.... system 1..1uriPBS sponsor
Fixed Value: http://hl7.org.au/id/pbs-sponsor
.... value 1..1string

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A PBS sponsor for medications in an Australian healthcare context
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: Common Languages (extensible)
Max Binding: All Languages
... text I0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional Content defined by implementations
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier ΣIIdentifierPBS Sponsor identifiers
Slice: Unordered, Open by value:system
... identifier ΣI1..1IdentifierPBS Sponsor Identifier
.... 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
Fixed Value: http://hl7.org.au/id/pbs-sponsor
.... 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)
... active ?!Σ0..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name ΣI0..1stringName used for the organization
... alias 0..*stringA list of alternate names that the organization is known as, or was known as in the past
... telecom I0..*ContactPointA contact detail for the organization
org-3: The telecom of an organization can never be of use 'home'
... address I0..*AddressAn address for the organization
org-2: An address of an organization can never be of use 'home'
... partOf Σ0..1Reference(Organization)The organization of which this organization forms a part
... contact I0..*BackboneElementContact for the organization for a certain purpose
.... id 0..1stringxml:id (or equivalent in JSON)
.... extension 0..*ExtensionAdditional Content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
.... purpose 0..1CodeableConceptThe type of contact
Binding: ContactEntityType (extensible)
.... name 0..1HumanNameA name associated with the contact
.... telecom 0..*ContactPointContact details (telephone, email, etc.) for a contact
.... address 0..1AddressVisiting or postal addresses for the contact
... endpoint 0..*Reference(Endpoint)Technical endpoints providing access to services operated for the organization

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-organisation

not defined