# AU PD Secure Messaging Endpoint - AU Provider Directory Implementation Guide v2.1.0-ci-build

* [**Table of Contents**](toc.md)
* [**Artifacts Summary**](artifacts.md)
* **AU PD Secure Messaging Endpoint**

## Resource Profile: AU PD Secure Messaging Endpoint 

| | | |
| :--- | :--- | :--- |
| *Official URL*:http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint | *Version*:2.1.0-ci-build | |
| * Standards status: *[Draft](http://hl7.org/fhir/R4/versions.html#std-process) | [Maturity Level](http://hl7.org/fhir/versions.html#maturity): 0 | *Computable Name*:AUPDSecureMessagingEndpoint |
| **Copyright/Legal**: HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved. | | |

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

### Usage Notes

**Profile specific implementation guidance:**

At least one of the following defined identifier types, known to this profile, **SHALL** be supplied:

* [PD Secure Messaging Delivery Target Identifier](StructureDefinition-au-pd-smdtargetidentifier.md)

**Usages:**

* Refer to this Profile: [AU PD Healthcare Service](StructureDefinition-au-pd-healthcareservice.md) and [AU PD Practitioner Role](StructureDefinition-au-pd-practitionerrole.md)
* Examples for this Profile: [Telstra Health Secure Messaging Endpoint](Endpoint-example0.md) and [Medical Objects Test Secure Messaging Endpoint](Endpoint-example1.md)

You can also check for [usages in the FHIR IG Statistics](https://packages2.fhir.org/xig/resource/hl7.fhir.au.pd|current/StructureDefinition/StructureDefinition-au-pd-sm-endpoint.json)

### Formal Views of Profile Content

 [Description of Profiles, Differentials, Snapshots and how the different presentations work](http://build.fhir.org/ig/FHIR/ig-guidance/readingIgs.html#structure-definitions). 

 

Other representations of profile: [CSV](StructureDefinition-au-pd-sm-endpoint.csv), [Excel](StructureDefinition-au-pd-sm-endpoint.xlsx), [Schematron](StructureDefinition-au-pd-sm-endpoint.sch) 

### Notes:

-------

**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)](http://hl7.org/fhir/http.html#read)

-------

**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)](http://hl7.org/fhir/search.html#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)](http://hl7.org/fhir/search.html#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)](http://hl7.org/fhir/search.html#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)](http://hl7.org/fhir/search.html#token)

-------

**Search: Receiving Facility Extension Elements (Custom)**

Search based string element content in the au-receivingfacility extension[1](searchparams.md). (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)](http://hl7.org/fhir/search.html#string)

* For searching explicitly for empty elements use **:missing=true** e.g. `au-receivingfacility-universal-id-type:missing=true`
* Definition: au-receivingfacility-namespace-id (MSH-6.1) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('namespace-id').value`
* Definition: au-receivingfacility-universal-id (MSH-6.2) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id').value`
* Definition: au-receivingfacility-universal-id-type (MSH-6.3) search `extension('http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility').extension('universal-id-type').value`

-------



## Resource Content

```json
{
  "resourceType" : "StructureDefinition",
  "id" : "au-pd-sm-endpoint",
  "extension" : [{
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
    "valueInteger" : 0,
    "_valueInteger" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org.au/fhir/pd/ImplementationGuide/hl7.fhir.au.pd"
      }]
    }
  },
  {
    "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
    "valueCode" : "draft",
    "_valueCode" : {
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
        "valueCanonical" : "http://hl7.org.au/fhir/pd/ImplementationGuide/hl7.fhir.au.pd"
      }]
    }
  }],
  "url" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint",
  "version" : "2.1.0-ci-build",
  "name" : "AUPDSecureMessagingEndpoint",
  "title" : "AU PD Secure Messaging Endpoint",
  "status" : "draft",
  "date" : "2026-06-23T04:50:00+00:00",
  "publisher" : "HL7 Australia",
  "contact" : [{
    "name" : "HL7 Australia FHIR Working Group",
    "telecom" : [{
      "system" : "url",
      "value" : "https://confluence.hl7.org/display/HAFWG",
      "use" : "work"
    }]
  }],
  "description" : "This profile defines content for describing details of an endpoint that would be adequate for addressing a secure message.",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "AU"
    }]
  }],
  "copyright" : "HL7 Australia© 2018+; Licensed Under Creative Commons No Rights Reserved.",
  "fhirVersion" : "4.0.1",
  "mapping" : [{
    "identity" : "rim",
    "uri" : "http://hl7.org/v3",
    "name" : "RIM Mapping"
  },
  {
    "identity" : "w5",
    "uri" : "http://hl7.org/fhir/fivews",
    "name" : "FiveWs Pattern Mapping"
  }],
  "kind" : "resource",
  "abstract" : false,
  "type" : "Endpoint",
  "baseDefinition" : "http://hl7.org/fhir/StructureDefinition/Endpoint",
  "derivation" : "constraint",
  "differential" : {
    "element" : [{
      "id" : "Endpoint",
      "path" : "Endpoint",
      "short" : "Australian Secure Message Directory Endpoint Record",
      "definition" : "Endpoint defined for use in secure message addressing.",
      "constraint" : [{
        "key" : "au-pd-ep-01",
        "severity" : "error",
        "human" : "At least one defined identifier, known to this AU PD Secure Messaging Endpoint profile, must be present",
        "expression" : "identifier.exists() implies identifier.where(system='http://ns.electronichealth.net.au/smd/target').exists()",
        "source" : "http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-sm-endpoint"
      }]
    },
    {
      "id" : "Endpoint.meta",
      "path" : "Endpoint.meta",
      "short" : "Metadata on Endpoint"
    },
    {
      "id" : "Endpoint.meta.source",
      "path" : "Endpoint.meta.source",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.extension",
      "path" : "Endpoint.extension",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "url"
        }],
        "rules" : "open"
      }
    },
    {
      "id" : "Endpoint.extension:receivingFacility",
      "path" : "Endpoint.extension",
      "sliceName" : "receivingFacility",
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-receivingfacility"]
      }]
    },
    {
      "id" : "Endpoint.extension:receivingApplication",
      "path" : "Endpoint.extension",
      "sliceName" : "receivingApplication",
      "max" : "1",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org.au/fhir/StructureDefinition/au-receivingapplication"]
      }]
    },
    {
      "id" : "Endpoint.extension:dataEnciphermentCertificate",
      "path" : "Endpoint.extension",
      "sliceName" : "dataEnciphermentCertificate",
      "type" : [{
        "code" : "Extension",
        "profile" : ["http://hl7.org.au/fhir/StructureDefinition/encryption-certificate-pem-x509"]
      }]
    },
    {
      "id" : "Endpoint.identifier",
      "path" : "Endpoint.identifier",
      "slicing" : {
        "discriminator" : [{
          "type" : "value",
          "path" : "system"
        }],
        "rules" : "open"
      },
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.identifier:smdtarget",
      "path" : "Endpoint.identifier",
      "sliceName" : "smdtarget",
      "short" : "Secure Messaging Target Identifier",
      "definition" : "Secure messaging interface target identity included in addressing metadata.  This is the complete URL identifier that can be directly used in secure messaging.  This identifier should be matched when selecting the encrypting certificate data used for payload encryption also referenced from this endpoint.",
      "type" : [{
        "code" : "Identifier",
        "profile" : ["http://hl7.org.au/fhir/pd/StructureDefinition/au-pd-smdtargetidentifier"]
      }],
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.status",
      "path" : "Endpoint.status",
      "short" : "Required status",
      "definition" : "Secure messaging endpoint activation status.",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.connectionType",
      "path" : "Endpoint.connectionType",
      "short" : "Service interface type",
      "definition" : "Protocol/Profile/Standard the endpoint supports.",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/service-interfaces"
      }
    },
    {
      "id" : "Endpoint.name",
      "path" : "Endpoint.name",
      "short" : "Friendly name for the endpoint",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.managingOrganization",
      "path" : "Endpoint.managingOrganization",
      "short" : "Directory entry managing organisation",
      "definition" : "Details of the organisation that is managing the supply of this directory entry.",
      "min" : 1,
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.managingOrganization.display",
      "path" : "Endpoint.managingOrganization.display",
      "short" : "Directory entry managing organisation display details",
      "definition" : "Details to display for the directory entry managing organisation, typically the name.",
      "min" : 1
    },
    {
      "id" : "Endpoint.contact",
      "path" : "Endpoint.contact",
      "short" : "Endpoint operator contact",
      "definition" : "Details to contact operator of the endpoint responsible for it's support and maintenance.",
      "mustSupport" : true
    },
    {
      "id" : "Endpoint.payloadType",
      "path" : "Endpoint.payloadType",
      "short" : "Payload type",
      "definition" : "Reference  to identify the type of payload content (service category).",
      "mustSupport" : true,
      "binding" : {
        "strength" : "extensible",
        "valueSet" : "http://hl7.org.au/fhir/pd/ValueSet/endpoint-payload-type"
      }
    },
    {
      "id" : "Endpoint.address",
      "path" : "Endpoint.address",
      "short" : "URL address of the endpoint",
      "definition" : "Actual endpoint URL for communications",
      "mustSupport" : true
    }]
  }
}

```
