Practitioner

Create Practitioner (Professional Contact)

Changed on

Creates a new professional contact profile (i.e. external practitioner)

post/main/Practitioner

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Practitioner
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

Request body

activeboolean nullable

Indicates if the user's record is in active use - changes to false if the user's profile is deactivated from the practice group

gender'male' | 'female' | 'other' | 'unknown' | 'null' nullable

male | female | other | unknown

birthDatestring nullable

The date on which the practitioner was born

containedFhirResourceInterfaceJsonfhir[]

Contained, inline Resources

idstring nullable

The practitioner identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)

resourceTypestring nullable

Resource Type

Response

Practitioner resource created

activeboolean nullable

Indicates if the user's record is in active use - changes to false if the user's profile is deactivated from the practice group

gender'male' | 'female' | 'other' | 'unknown' | 'null' nullable

male | female | other | unknown

birthDatestring nullable

The date on which the practitioner was born

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The practitioner identifier within the practice group, wherein the ID includes the appropriate prefix for internal practitioner (PR-) or professional contact (EP-)

resourceTypestring nullable

Resource Type

Changes

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      removed the optional property // from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property // from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /////// response property for the response status (media type: application/json)

    • info

      added the new ValueSet enum value to the request property /////// (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property /////// (media type: application/json)

    • info

      added the new ValueSet enum value to the request property ///////// (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property ///////// (media type: application/json)

    • info

      added the new ValueSet enum value to the request property /////// (media type: application/fhir+json)

    • info

      added the new ValueSet enum value to the request property /////// (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property /////// (media type: application/fhir+json)

    • info

      added the new ValueSetConcept enum value to the request property /////// (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property ///////// (media type: application/fhir+json)

    • info

      added the new ValueSetConcept enum value to the request property ///////// (media type: application/json)

    • info

      added the new ValueSetConcept enum value to the request property /////// (media type: application/fhir+json)

    • info

      added the new ValueSetConcept enum value to the request property /////// (media type: application/json)