04 · Visit

Server

Calls made at Visit. Taught at /rail/stops/Visit.

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical.

Keep from the response: visit_ref

Taught in: 04 · Visit

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical. › Request Body

unique_patient_id

string

service_type

string

selection_ref

string

consent_ref

string

object[]

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical. › Responses

200

Returns visit_ref.

No data returned

POST/api/v2/visits

curl https://api-dev.slade360edi.com/orchestrator/api/v2/visits \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "unique_patient_id": "{{unique_patient_id}}",
  "service_type": "OUTPATIENT",
  "selection_ref": "{{selection_ref}}",
  "consent_ref": "{{consent_ref}}",
  "service_lines": [
    {
      "code": "{{intervention_code}}",
      "cover": "{{cover_id}}"
    }
  ]
}'

Example Request Body

{
  "unique_patient_id": "{{unique_patient_id}}",
  "service_type": "OUTPATIENT",
  "selection_ref": "{{selection_ref}}",
  "consent_ref": "{{consent_ref}}",
  "service_lines": [
    {
      "code": "{{intervention_code}}",
      "cover": "{{cover_id}}"
    }
  ]
}

json

application/json

Example Responses

No example specified for this content type

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits/{visit_ref}/service-lines

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused.

Keep from the response: service_line_ref

Taught in: 04 · Visit

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › path Parameters

visit_ref

string · required

visit ref

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › Request Body

code

string

cover

string

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › Responses

200

Returns service_line_ref.

No data returned

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits/{visit_ref}/practitioners

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored.

Keep from the response: practitioner_ref

Taught in: 04 · Visit

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › path Parameters

visit_ref

string · required

visit ref

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › Request Body

id

string

id_type

string

regulation_body

string

role

string

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › Responses

200

Returns practitioner_ref.

No data returned

03 · Consent 05 · Treat

The Rail

04 · Visit

Server

Calls made at Visit. Taught at /rail/stops/Visit.

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical.

Keep from the response: visit_ref

Taught in: 04 · Visit

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical. › Request Body

unique_patient_id

string

service_type

string

selection_ref

string

consent_ref

string

object[]

Open a visit — an encounter and its account, in one atomic write. No payer is called; a visit with no service_lines is purely clinical. › Responses

200

Returns visit_ref.

No data returned

POST/api/v2/visits

curl https://api-dev.slade360edi.com/orchestrator/api/v2/visits \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "unique_patient_id": "{{unique_patient_id}}",
  "service_type": "OUTPATIENT",
  "selection_ref": "{{selection_ref}}",
  "consent_ref": "{{consent_ref}}",
  "service_lines": [
    {
      "code": "{{intervention_code}}",
      "cover": "{{cover_id}}"
    }
  ]
}'

Example Request Body

{
  "unique_patient_id": "{{unique_patient_id}}",
  "service_type": "OUTPATIENT",
  "selection_ref": "{{selection_ref}}",
  "consent_ref": "{{consent_ref}}",
  "service_lines": [
    {
      "code": "{{intervention_code}}",
      "cover": "{{cover_id}}"
    }
  ]
}

json

application/json

Example Responses

No example specified for this content type

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits/{visit_ref}/service-lines

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused.

Keep from the response: service_line_ref

Taught in: 04 · Visit

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › path Parameters

visit_ref

string · required

visit ref

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › Request Body

code

string

cover

string

Authorise a cover for a named intervention — the authorization unit. Payer-first: pending, then authorized or refused. › Responses

200

Returns service_line_ref.

No data returned

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored.

POST

https://api-dev.slade360edi.com/orchestrator

/api/v2/visits/{visit_ref}/practitioners

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored.

Keep from the response: practitioner_ref

Taught in: 04 · Visit

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › path Parameters

visit_ref

string · required

visit ref

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › Request Body

id

string

id_type

string

regulation_body

string

role

string

Record a practitioner on the visit, validated against the Health Worker Registry under its regulator before it is stored. › Responses

200

Returns practitioner_ref.

No data returned

03 · Consent 05 · Treat