Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A PUT to the patients/status endpoint is used to update a patient's search status with the Search & Match Service.  Allowable status values are SUS, PRE, ACT and STP.  A new patient is defaulted to the new (NEW) state.  Under the NEW state, searches must be requested explicitly.  When doing so, the patient is moved to the PRE state. Under the ACT state, searches will be kept up to date automatically.  SUS will stop automatic updates to searches, but results will remain for 42 days.  STP will terminate the search and delete all search results.

...

@startuml
start
:API/GUI; 
note right: Patient registry

...

Include Page
BMDWPUB:Patient states and their effect on automatic updating of search results (full logic)
BMDWPUB:Patient states and their effect on automatic updating of search results (full logic)


Put
patients/status
Expand
titleRequest...
FieldDetails
wmdaId*integer
example: 123456

nullable: false
newStatus*

string
nullable: false

Enum:
Array [ 4 ]

changeReasonstring
nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]
Expand
titleResponse...
FieldDetails
wmdaId*integer
example: 123456

nullable: false
status*

string
maxLength: 3

nullable: false

Enum:
Array [ 4 ]

changeReasonstring
maxLength: 3

nullable: true

Reason why the change was made. Mandatory when changing to "STP"

Enum:
Array [ 21 ]

...