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.8 StructureDefinition-au-pd-sm-endpoint

Australian Secure Messaging Endpoint Directory Entry

This profile describes content for describing details of an endpoint that would be adequate for addressing a secure message.

Examples

Secure Messaging Endpoint Example

SD.8.1 Formal Views of Profile Content

The official URL for this profile is: 

http://hl7.org.au/fhir/StructureDefinition/au-pd-sm-endpoint

Endpoint for secure message delivery

This profile builds on Endpoint.

This profile was published on Fri May 12 16:13:53 AEST 2017 as a draft by null.

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

Australian Secure Messaging Endpoint Directory Entry

  1. Must Support Required: Active Status (code)
  2. Must Support Required: Connection Type - Service Interface Type (Coding)
  3. Must Support Required: Managing Organisation (with display text) (Organization Reference)
  4. Must Support Required: Payload Type - Service Category (CodeableConcept)
  5. Must Support Optional Extension: Receiving Facility (Complex)
  6. Must Support Optional Extension: Receiving Application (Complex)
  7. Must Support Optional Extension: Encrypting Certficate Details - reference or value (uri, string)
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*Australian Secure Message Directory Endpoint Record
... status S1..1code
... connectionType S1..1Coding​Service interface type
Binding: Australian Service Interfaces (required)
... name S0..1string
... managingOrganization S1..1Reference(Organization)Directory entry managing organisation.
.... display 1..1stringDirectroy entry managing organisation display details
... contact S0..*ContactPointEndpoint operator contact
... payloadType S1..*CodeableConceptPayload type
Binding: Australian Endpoint Payload Types (preferred)
... address S1..1uriURL address of the endpoint
... au-receivingfacility 0..1(Complex)Receiving Facility Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... au-receivingapplication 0..1(Complex)Receiving Application Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
... encrypting-qualified-certificate-reference S0..*string, uriEncrypting certificate details
URL: http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*Australian Secure Message Directory Endpoint Record
... 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
... au-receivingfacility I0..1(Complex)Receiving Facility Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... au-receivingapplication I0..1(Complex)Receiving Application Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
... encrypting-qualified-certificate-reference S0..*string, uriEncrypting certificate details
URL: http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType SΣ1..1Coding​Service interface type
Binding: Australian Service Interfaces (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(Organization)Directory entry managing organisation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringDirectroy entry managing organisation display details
... contact S0..*ContactPointEndpoint operator contact
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..*CodeableConceptPayload type
Binding: Australian Endpoint Payload Types (preferred)
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: IETF BCP-13 (required)
... address SΣ1..1uriURL address of the endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

Australian Secure Messaging Endpoint Directory Entry

  1. Must Support Required: Active Status (code)
  2. Must Support Required: Connection Type - Service Interface Type (Coding)
  3. Must Support Required: Managing Organisation (with display text) (Organization Reference)
  4. Must Support Required: Payload Type - Service Category (CodeableConcept)
  5. Must Support Optional Extension: Receiving Facility (Complex)
  6. Must Support Optional Extension: Receiving Application (Complex)
  7. Must Support Optional Extension: Encrypting Certficate Details - reference or value (uri, string)

Differential View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint 0..*Australian Secure Message Directory Endpoint Record
... status S1..1code
... connectionType S1..1Coding​Service interface type
Binding: Australian Service Interfaces (required)
... name S0..1string
... managingOrganization S1..1Reference(Organization)Directory entry managing organisation.
.... display 1..1stringDirectroy entry managing organisation display details
... contact S0..*ContactPointEndpoint operator contact
... payloadType S1..*CodeableConceptPayload type
Binding: Australian Endpoint Payload Types (preferred)
... address S1..1uriURL address of the endpoint
... au-receivingfacility 0..1(Complex)Receiving Facility Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... au-receivingapplication 0..1(Complex)Receiving Application Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
... encrypting-qualified-certificate-reference S0..*string, uriEncrypting certificate details
URL: http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. Endpoint I0..*Australian Secure Message Directory Endpoint Record
... 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
... au-receivingfacility I0..1(Complex)Receiving Facility Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility
... au-receivingapplication I0..1(Complex)Receiving Application Details
URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication
... encrypting-qualified-certificate-reference S0..*string, uriEncrypting certificate details
URL: http://hl7.org.au/fhir/StructureDefinition/encrypting-qualified-certificate-reference
... modifierExtension ?!0..*ExtensionExtensions that cannot be ignored
... identifier Σ0..*IdentifierIdentifies this endpoint across multiple systems
... status ?!SΣ1..1codeactive | suspended | error | off | entered-in-error | test
Binding: EndpointStatus (required)
... connectionType SΣ1..1Coding​Service interface type
Binding: Australian Service Interfaces (required)
... name SΣ0..1stringA name that this endpoint can be identified by
... managingOrganization SΣ1..1Reference(Organization)Directory entry managing organisation.
.... id 0..1stringxml:id (or equivalent in JSON)
.... reference ΣI0..1stringLiteral reference, Relative, internal or absolute URL
.... identifier Σ0..1IdentifierLogical reference, when literal reference is not known
.... display Σ1..1stringDirectroy entry managing organisation display details
... contact S0..*ContactPointEndpoint operator contact
... period Σ0..1PeriodInterval the endpoint is expected to be operational
... payloadType SΣ1..*CodeableConceptPayload type
Binding: Australian Endpoint Payload Types (preferred)
... payloadMimeType Σ0..*codeMimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this)
Binding: IETF BCP-13 (required)
... address SΣ1..1uriURL address of the endpoint
... header 0..*stringUsage depends on the channel type

doco Documentation for this format

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

 

SD.8.2 Quick Start

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

Read: Endpoint Read identified endpoint resource content.

GET [base]/Endpoint/[id]

Example: GET [base]/Endpoint/1234

Support: MUST support read Endpoint

Implementation Notes: [(how to read resource)

Search: Connection Type (Service Interface)

Search based on token for a protocol to be used to connnect to the endpoint.

GET [base]/Endpoint?connection-type=[system]|[value]

Example: GET [base]/Endpoint?connection-type=http://hl7.org.au.fhir/ValueSet/au-serviceinterfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010

Support: SHOULD support search by Connection Type.

Implementation Notes: (how to search by token)

Search: Payload Type (Service Category)

Search based on token for the type of content supported by the endpoint.

GET [base]/Endpoint?payload-type=[system]|[value]

Example: GET [base]/Endpoint?payload-type=http://hl7.org.au.fhir/ValueSet/valueset-au-endpoint-payload-type|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706

Support: SHOULD support search by Payload Type.

Implementation Notes: (how to search by token)