Australian Profile for Provider Directory Services

This page is part of the Australian Provider Directory IG (v0.2.0: PD 1 on FHIR STU3 Draft) based on FHIR R3. The current version which supercedes this version is 2.0.1. For a full list of available versions, see the Directory of published versions

SD.6 StructureDefinition-au-pd-organisation

Australian Organisation Directory Entry Profile

Provider directory entry for an organisation.

Examples

Organisation Directory Entry Example

SD.6.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-pd-organisation

This profile builds on Australian Healthcare Organisation.

This profile was published on Fri May 05 17:01:18 AEST 2017 as a draft by null.

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

Australian Organisation Directory Entry

  1. Must Support Optional: HPI-O
  2. Must Support Required: Active Status
  3. Must Support Required: Organisation Name
  4. Must Support 0 or more: Contact Details, phone,fax, email etc.
  5. Must Support 0 or more: Contact Addresses
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier S0..*IdentifierHPI-O
... active S1..1boolean
... name S1..1string
... telecom S0..*ContactPoint
... address S0..*Address

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... 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)
... 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 ΣIIdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system, value:type
... identifier SΣI0..*IdentifierHPI-O
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..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 SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
... 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

Australian Organisation Directory Entry

  1. Must Support Optional: HPI-O
  2. Must Support Required: Active Status
  3. Must Support Required: Organisation Name
  4. Must Support 0 or more: Contact Details, phone,fax, email etc.
  5. Must Support 0 or more: Contact Addresses

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization 0..*
... identifier S0..*IdentifierHPI-O
... active S1..1boolean
... name S1..1string
... telecom S0..*ContactPoint
... address S0..*Address

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Organization I0..*A grouping of people or organizations with a common purpose
... 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)
... 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 ΣIIdentifierIdentifies this organization across multiple systems
Slice: Unordered, Open by value:system, value:type
... identifier SΣI0..*IdentifierHPI-O
... active ?!SΣ1..1booleanWhether the organization's record is still in active use
... type Σ0..*CodeableConceptKind of organization
Binding: OrganizationType (example)
... name SΣI1..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 SI0..*ContactPointA contact detail for the organization
... address SI0..*AddressAn address for the organization
... 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

 

SD.6.2 Quick Start

Below is an overview of the requirements for search and read operations.

Read: Organisation

Read identified organisation resource content.

GET [base]/Organization/[id]

Example: GET [base]/Organization/1234

Support: MUST support read Organisation

Implementation Notes: [(how to read resource)

Search: HPI-O

Search based on identifier token.

GET [base]/Organization?identifier=[system]|[value]

Example: GET [base]/Organization?identifier=http://ns.electronichealth.net.au/id/hi/hpio/1.0|8003627500000328

Support: SHOULD support search by HPI-O.

Implementation Notes: (how to search by token)