Australian Provider Directory Implementation Guide (PD 2)
This page is part of the Australian Provider Directory IG (v2.0.1: PD 2 on FHIR R4) based on FHIR R4. 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 
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.
Secure Messaging Endpoint Example (Telstra Health)
Secure Messaging Endpoint Example (Medical Objects)
The official URL for this profile is:
http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint
Endpoint for secure message delivery
This profile builds on Endpoint.
This profile was published on Tue May 14 00:00:00 AEST 2019 as a draft by null.
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
Australian Secure Messaging Endpoint Directory Entry
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Endpoint | 0..* | Australian Secure Message Directory Endpoint Record | ||
 meta | 0..1 | Meta | Metadata on Endpoint | |
  source | S | 0..1 | uri | |
 extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
 au-receivingfacility | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
| au-receivingapplication | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
| encryption-certificate-pem-x509 | 0..* | string | PEM X509 Certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
 identifier | (Slice Definition) | Slice: Unordered, Open by value:system | ||
 smdtarget | S | 0..* | Identifier | Secure Messaging Target Identifier |
  system | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target | |
 value | 1..1 | string | Secure messaging target identifier value | |
| status | S | 1..1 | code | Required status |
| connectionType | S | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
| name | S | 0..1 | string | Friendly name for the endpoint |
| managingOrganization | S | 1..1 | Reference(Organization) | Directory entry managing organisation |
| display | 1..1 | string | Directroy entry managing organisation display details | |
| contact | S | 0..* | ContactPoint | Endpoint operator contact |
| payloadType | S | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
| address | S | 1..1 | url | URL address of the endpoint |
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | Australian Secure Message Directory Endpoint Record | |
 id | Σ | 0..1 | id | Logical id of this artifact |
 meta | Σ | 0..1 | Meta | Metadata on Endpoint |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | SΣ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| au-receivingfacility | I | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility |
| au-receivingapplication | I | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication |
| encryption-certificate-pem-x509 | I | 0..* | string | PEM X509 Certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 |
 modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | (Slice Definition) | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system | |
| smdtarget | SΣ | 0..* | Identifier | Secure Messaging Target Identifier |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
| value | Σ | 1..1 | string | Secure messaging target identifier value Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
 assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | Required status Binding: EndpointStatus (required) |
| connectionType | SΣ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
| name | SΣ | 0..1 | string | Friendly name for the endpoint |
| managingOrganization | SΣ | 1..1 | Reference(Organization) | Directory entry managing organisation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Directroy entry managing organisation display details |
| contact | S | 0..* | ContactPoint | Endpoint operator contact |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
| payloadMimeType | Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required) |
| address | SΣ | 1..1 | url | URL address of the endpoint |
| header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
Australian Secure Messaging Endpoint Directory Entry
Differential View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | 0..* | Australian Secure Message Directory Endpoint Record | ||
| meta | 0..1 | Meta | Metadata on Endpoint | |
| source | S | 0..1 | uri | |
| extension | 0..* | Extension | Slice: Unordered, Open by value:url | |
| au-receivingfacility | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility | |
| au-receivingapplication | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication | |
| encryption-certificate-pem-x509 | 0..* | string | PEM X509 Certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 | |
| identifier | (Slice Definition) | Slice: Unordered, Open by value:system | ||
| smdtarget | S | 0..* | Identifier | Secure Messaging Target Identifier |
| system | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target | |
| value | 1..1 | string | Secure messaging target identifier value | |
| status | S | 1..1 | code | Required status |
| connectionType | S | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
| name | S | 0..1 | string | Friendly name for the endpoint |
| managingOrganization | S | 1..1 | Reference(Organization) | Directory entry managing organisation |
| display | 1..1 | string | Directroy entry managing organisation display details | |
| contact | S | 0..* | ContactPoint | Endpoint operator contact |
| payloadType | S | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
| address | S | 1..1 | url | URL address of the endpoint |
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| Endpoint | I | 0..* | Australian Secure Message Directory Endpoint Record | |
| id | Σ | 0..1 | id | Logical id of this artifact |
| meta | Σ | 0..1 | Meta | Metadata on Endpoint |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| versionId | Σ | 0..1 | id | Version specific identifier |
| lastUpdated | Σ | 0..1 | instant | When the resource version last changed |
| source | SΣ | 0..1 | uri | Identifies where the resource comes from |
| profile | Σ | 0..* | canonical(StructureDefinition) | Profiles this resource claims to conform to |
| security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible) |
| tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example) |
| implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| contained | 0..* | Resource | Contained, inline Resources | |
| extension | 0..* | Extension | Extension Slice: Unordered, Open by value:url | |
| au-receivingfacility | I | 0..1 | (Complex) | HL7 V2 receiving facility URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility |
| au-receivingapplication | I | 0..1 | (Complex) | HL7 V2 receiving application URL: http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication |
| encryption-certificate-pem-x509 | I | 0..* | string | PEM X509 Certificate URL: http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509 |
| modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored |
| identifier | Σ | (Slice Definition) | Identifies this endpoint across multiple systems Slice: Unordered, Open by value:system | |
| smdtarget | SΣ | 0..* | Identifier | Secure Messaging Target Identifier |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required) |
| type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible) |
| system | Σ | 1..1 | uri | Secure Messaging Delivery Target Identifier Fixed Value: http://ns.electronichealth.net.au/smd/target |
| value | Σ | 1..1 | string | Secure messaging target identifier value Example General': 123456 |
| period | Σ | 0..1 | Period | Time period when id is/was valid for use |
| assigner | Σ | 0..1 | Reference(Organization) | Organization that issued id (may be just text) |
| status | ?!SΣ | 1..1 | code | Required status Binding: EndpointStatus (required) |
| connectionType | SΣ | 1..1 | Coding | Service interface type Binding: Australian Service Interfaces (extensible) |
| name | SΣ | 0..1 | string | Friendly name for the endpoint |
| managingOrganization | SΣ | 1..1 | Reference(Organization) | Directory entry managing organisation |
| id | 0..1 | string | Unique id for inter-element referencing | |
| extension | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| reference | ΣI | 0..1 | string | Literal reference, Relative, internal or absolute URL |
| type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible) |
| identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known |
| display | Σ | 1..1 | string | Directroy entry managing organisation display details |
| contact | S | 0..* | ContactPoint | Endpoint operator contact |
| period | Σ | 0..1 | Period | Interval the endpoint is expected to be operational |
| payloadType | SΣ | 1..* | CodeableConcept | Payload type Binding: Australian Endpoint Payload Types (extensible) |
| payloadMimeType | Σ | 0..* | code | Mimetype to send. If not specified, the content could be anything (including no payload, if the connectionType defined this) Binding: Mime Types (required) |
| address | SΣ | 1..1 | url | URL address of the endpoint |
| header | 0..* | string | Usage depends on the channel type | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
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: Active Status
Search based on active status of the endpoint record.
GET [base]/Endpoint?status=[code]
Example: GET [base]/Endpoint?status=active
Support: MUST support search Organization by active status code (active | suspended | error | off | entered-in-error | test)
Implementation Notes: (how to search by token)
Search: Identifier (Secure Messaging Target Identifier)
Search based on identifier token.
GET [base]/Endpoint?identifier=[system]|[value]
Example: GET [base]/Endpoint?identifier=http://ns.electronichealth.net.au/smd/target|http://ns.argusdca.com.au/smd/id/hostname/ACC5959010000000
Support: MUST support search by Secure Messaging Target Identifier
Implementation Notes: (how to search by token)
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]|[code]
Example: GET [base]/Endpoint?connection-type=http://hl7.org.au/fhir/CodeSystem/smd-interfaces|http://ns.electronichealth.net.au/smd/intf/SealedMessageDelivery/TLS/2010
Support: MUST 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]|[code]
Example: GET [base]/Endpoint?payload-type=http://hl7.org.au/fhir/CodeSystem/endpoint-payload-type|http://ns.hl7.org.au/hl7v2/profiles/HL7AU-OO-REF-SIMPLIFIED-201706
Support: MUST support search by Payload Type.
Implementation Notes: (how to search by token)
Search: Receiving Facility Extension Elements (Custom)
Search based string element content in the au-receivingfacility extension1. (namespace-id, universal-id, universal-id-type)
GET [base]/Endpoint?au-receivingfacility-namespace-id=[string]&au-receivingfacility-universal-id=[string]&au-receivingfacility-universal-id-type=[string]
Example: GET [base]/Endpoint?au-receivingfacility-namespace-id=Buderim Medical Center&au-receivingfacility-universal-id=877F9695-1298-4E6A-B432-0FDD46AD80B8&au-receivingfacility-universal-id-type=GUID
Support: MUST support search by Receiving Facility Extension Elements.
Implementation Notes: (how to search by string)
au-receivingfacility-universal-id-type:missing=trueextension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('namespace-id').valueextension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id').valueextension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id-type').value
© PD 2 on FHIR R4 (IG Publisher v4.0.0-a53ec6ee1b) generated on Thu, Aug 15, 2019 21:28+1000. |
