> For the complete documentation index, see [llms.txt](https://help.santesuite.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.santesuite.org/developers/service-apis/health-data-service-interface-hdsi/api-documentation/mailbox-mail-message.md).

# Mailbox Mail Message

Associates a

## GET /MailboxMailMessage/\_export

> Get the dataset for the specified object

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/_export":{"get":{"tags":["MailboxMailMessage"],"summary":"Get the dataset for the specified object","parameters":[{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{},"application/json":{},"application/xml":{}},"type":"string"}}}}}
```

## GET /MailboxMailMessage/{id}/\_export

> Get the dataset for the specified object

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}/_export":{"get":{"tags":["MailboxMailMessage"],"summary":"Get the dataset for the specified object","parameters":[{"schema":{"type":"string"},"name":"id","in":"path"},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## Perform a search (query) for

> The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage":{"get":{"tags":["MailboxMailMessage"],"summary":"Perform a search (query) for","description":"The search operation calls the database and loads results either from cache or data store. Care should be taken in the number of results retrieved by this operation.","parameters":[{"schema":{"type":"number"},"name":"_offset","in":"query","description":"The offet of the first result to return","required":false},{"schema":{"type":"number"},"name":"_count","in":"query","description":"The count of items to return in this result set","required":false},{"schema":{"type":"boolean"},"name":"_includeTotal","in":"query","description":"True if the server should count the matching results. May reduce performance","required":false},{"schema":{"type":"string"},"name":"_orderBy","in":"query","description":"Instructs the result set to be ordered (in format: property:(asc|desc))","required":false},{"schema":{"type":"string"},"name":"_queryId","in":"query","description":"The query state identifier. This allows the client to get a stable result set.","required":false},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## Creates the resource. If the resource already exists, then a 409 is thrown

> This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage":{"post":{"tags":["MailboxMailMessage"],"summary":"Creates the resource. If the resource already exists, then a 409 is thrown","description":"This operation is a CREATE ONLY operation, and will throw an error if the operation results in a duplicate. If you are looking for a CREATE OR UPDATE method use the POST with identifier operation","parameters":[{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"409":{"description":"There is a conflict in the update request (version mismatch)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}},"description":"The body of the request"}}}}}
```

## OPTIONS /MailboxMailMessage

> Returns specific options for a single resource

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/MailboxMailMessage":{"options":{"tags":["MailboxMailMessage"],"summary":"Returns specific options for a single resource","responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}},"components":{"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}}}
```

## Perform a search (query) and return only the headers

> The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/MailboxMailMessage":{"head":{"tags":["MailboxMailMessage"],"summary":"Perform a search (query) and return only the headers","description":"The HEAD operation is useful if you wish to determine if the header information for a specific result set has resulted in a change","parameters":[{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}},"components":{"schemas":{"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}}}
```

## Retrieves the current version of the specified resource

> This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}":{"get":{"tags":["MailboxMailMessage"],"summary":"Retrieves the current version of the specified resource","description":"This method will first use cache to locate the most recent copy before searching the database. It is recommended to use this method rather than a query to Resource?id={id}","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the object which should be retrieved"},{"schema":{"type":"boolean"},"name":"_bundle","in":"query","description":"True if the server should send related objects to the caller in a bundle","required":false},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does

> This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}":{"post":{"tags":["MailboxMailMessage"],"summary":"Creates or updates a resource. That is, creates the resource if it does not exist, or updates it if it does","description":"This method will attempt to update the resource if it exists (a-la PUT style) however, if a PUT fails the operation will create (a-la POST)","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to be created or updated"},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}},"description":"The resource which is to be created or updated"}}}}}
```

## Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown

> This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.
> \
>             
> \
>              Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}":{"put":{"tags":["MailboxMailMessage"],"summary":"Updates the specified resource. If the resource does not exist than a 404 is thrown, if there is a conflict (such a mismatch of data) a 409 is thrown","description":"This operation will update an existing resource on the server such that the data in the database exactly matches the data passed via the API.\r\n            \r\n             Note: If you post an incomplete object (such as one missing identifiers, or addresses) then the current resource will have those attributes removed. For partial updates, use the PATCH operation instead.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to be updated"},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"409":{"description":"There is a conflict in the update request (version mismatch)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}},"description":"The new contents of the resource to be updated"}}}}}
```

## Deletes the specified resource from the server

> This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}":{"delete":{"tags":["MailboxMailMessage"],"summary":"Deletes the specified resource from the server","description":"This operation either logically or permanently deletes the identified resource so that it no longer appears in general searches. The method of deletion is controlled by the","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to be deleted"},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"409":{"description":"There is a conflict in the update request (version mismatch)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## Retrieves only the metadata of the specified resource

> The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/MailboxMailMessage/{id}":{"head":{"tags":["MailboxMailMessage"],"summary":"Retrieves only the metadata of the specified resource","description":"The metadata for the most recent version of this resource includes the last modified time, the e-tag, etc.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to be retrieved"},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}},"components":{"schemas":{"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}}}
```

## Updates the specified resource according to the instructions in the PATCH file

> The PATCH operation allows for partial updating of a resource.
> \
>             
> \
>              This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.
> \
>             
> \
>              The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"Patch":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"version":{"xml":{"name":"version","attribute":true},"description":"Gets or sets the version of the patch file","type":"string"},"appliesTo":{"xml":{"name":"appliesTo","attribute":false},"description":"Application version","schema":{"$ref":"#/components/schemas/PatchTarget"}},"change":{"xml":{"name":"change","attribute":false},"description":"A list of patch operations to be applied to the object","type":"array","items":{"$ref":"#/components/schemas/PatchOperation","type":"object"}},"creationTime":{"xml":{"name":"creationTime","attribute":false},"description":"Gets or sets the creation time as an ISO date format","type":"string"},"obsoletionTime":{"xml":{"name":"obsoletionTime","attribute":false},"description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time that the object was last modified (from base data, default to CreationTime)","type":"string","format":"date"},"createdBy":{"xml":{"name":"createdBy","attribute":false},"description":"Gets or sets the security provenance object which represents the creation of this object","type":"string","format":"uuid"},"obsoletedBy":{"xml":{"name":"obsoletedBy","attribute":false},"description":"Gets or sets the security provenance object which represents the obsoletion of this data","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Represents a series of patch instructions","type":"object"},"PatchTarget":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":true},"description":"Identifies the target type","type":"string"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the key","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets or sets the tag of the item","type":"string"}},"description":"Represents a target of a patch","type":"object"},"PatchOperation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"op":{"xml":{"name":"op","attribute":true},"description":"Gets or sets the operation type","type":"string","enum":["add","remove","replace","test","test-ne"]},"path":{"xml":{"name":"path","attribute":true},"description":"Gets or sets the path","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Get or sets the value","schema":{"$ref":"#/components/schemas/Object"}}},"description":"Represents a single patch operation","type":"object"},"Object":{"properties":{},"type":"object"}}},"paths":{"/MailboxMailMessage/{id}":{"patch":{"tags":["MailboxMailMessage"],"summary":"Updates the specified resource according to the instructions in the PATCH file","description":"The PATCH operation allows for partial updating of a resource.\r\n            \r\n             This method must be used in conjunction with an If-Match header indicating the version that you would like apply the patch against.\r\n            \r\n             The server will load the most recent version and compre the version code with If-Match, if the match is successful the instructions in the PATCH are applied to the loaded version.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to be patched"}],"responses":{"204":{"description":"There is not response for this method"},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"409":{"description":"The patch submitted does not match the current version of the object being patched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patch"}},"application/json":{"schema":{"$ref":"#/components/schemas/Patch"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patch"}}},"description":"The patch body which contains update instructions on the object referenced by"}}}}}
```

## Invokes the specified operation

> In SanteDB an operation or method is invoked using

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"Object":{"properties":{},"type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"}}},"paths":{"/MailboxMailMessage/{id}/$diff":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The ID of the object which scopes the operation"},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}}},"description":"The parameters to invoke the operation with"}}}}}
```

## Invokes the specified operation

> In SanteDB an operation or method is invoked using

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"Object":{"properties":{},"type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"}}},"paths":{"/MailboxMailMessage/{id}/$tag":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","description":"In SanteDB an operation or method is invoked using","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The ID of the object which scopes the operation"},{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}}},"description":"The parameters to invoke the operation with"}}}}}
```

## Gets the specified barcode for the resource

> This method returns a barcode which explicitly points at the specified resource in the specified authority.
> \
>             
> \
>              The barcode is generated using the server's configuration, and is signed by the server's signing key.
> \
>             
> \
> &#x20;            For complete specification see: <https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api>

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}/_code":{"get":{"tags":["MailboxMailMessage"],"summary":"Gets the specified barcode for the resource","description":"This method returns a barcode which explicitly points at the specified resource in the specified authority.\r\n            \r\n             The barcode is generated using the server's configuration, and is signed by the server's signing key.\r\n            \r\n             For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource for which a VRP should be generated"},{"schema":{"type":"string"},"name":"_format","in":"query","description":"The format of the barcode (santedb-vrp, code39, etc.)","required":false},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## Gets the digitally signed pointer (in JWS format) for the resource

> This operation (like the \_code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return
> \
> &#x20;            the structured contents of that code so the client can best determine how to represent the data.
> \
> &#x20;          &#x20;
> \
> &#x20;            For complete specification see: <https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api>

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"MailboxMailMessage":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"message":{"xml":{"name":"message","attribute":false},"description":"Gets the target of the association","type":"string","format":"uuid"},"flags":{"xml":{"name":"flags","attribute":false},"description":"Gets or sets the flags","type":"string","enum":["u","r","f","c"]},"time":{"xml":{"name":"time","attribute":false},"description":"Gets or sets the time of the alert.","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Get the modification date","type":"string","format":"date"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"id":{"xml":{"name":"id","attribute":false},"description":"Gets or sets the primary identifying UUID of this object","type":"string","format":"uuid"},"operation":{"xml":{"name":"operation","attribute":true},"description":"Gets or sets the operation","type":"string","enum":["Auto","Insert","InsertOrUpdate","Update","Delete","Ignore","DeletePreserveContained"]},"$type":{"description":"Gets the type registration of this object","type":"string"}},"description":"Associates a","type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"}}},"paths":{"/MailboxMailMessage/{id}/_ptr":{"get":{"tags":["MailboxMailMessage"],"summary":"Gets the digitally signed pointer (in JWS format) for the resource","description":"This operation (like the _code operation) generates a digitally signed pointer for an object. Rather than rendering that pointer as a visual code, the API will return\r\n             the structured contents of that code so the client can best determine how to represent the data.\r\n            \r\n             For complete specification see: https://help.santesuite.org/santedb/extending-santedb/service-apis/health-data-service-interface-hdsi/digitally-signed-visual-code-api","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the object for which the pointer should be created"},{"schema":{"type":"string"},"name":"message","in":"query","description":"Gets the target of the association"},{"schema":{"type":"string","enum":["u","r","f","c"]},"name":"flags","in":"query","description":"Gets or sets the flags"},{"schema":{"type":"string"},"name":"time","in":"query","description":"Gets or sets the time of the alert."},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Get the modification date"},{"schema":{"type":"string"},"name":"source","in":"query","description":"Gets or sets the source entity's key (where the relationship is FROM)"},{"schema":{"type":"string"},"name":"id","in":"query","description":"Gets or sets the primary identifying UUID of this object"},{"schema":{"type":"string"},"name":"$self","in":"query","description":"A query parameter which references itself - this is for query filters which pass the original data in"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Gets a tag which changes whenever the object is updated"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}},"application/xml":{"schema":{"$ref":"#/components/schemas/MailboxMailMessage"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false}}}}
```

## POST /MailboxMailMessage/$xsd-complete

> Invokes the specified operation

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"Object":{"properties":{},"type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"}}},"paths":{"/MailboxMailMessage/$xsd-complete":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","parameters":[{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}}},"description":"The parameters to invoke the operation with"}}}}}
```

## POST /MailboxMailMessage/$schema-complete

> Invokes the specified operation

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"Object":{"properties":{},"type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"}}},"paths":{"/MailboxMailMessage/$schema-complete":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","parameters":[{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}}},"description":"The parameters to invoke the operation with"}}}}}
```

## POST /MailboxMailMessage/$xref-use

> Invokes the specified operation

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Associates a","name":"MailboxMailMessage"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.0.17","1.3.6.1.4.1.33349.3.1.5.9.2.1.0"]}],"components":{"securitySchemes":{"svc_auth":{"type":"oauth2","flows":{"password":{"tokenUrl":"https://ims-ncc1701.santesuite.net:8443/auth/oauth2_token","scopes":{"1.3.6.1.4.1.33349.3.1.5.9.2":"Unrestricted All","1.3.6.1.4.1.33349.3.1.5.9.2.0":"Unrestricted Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.0.1":"Change Password","1.3.6.1.4.1.33349.3.1.5.9.2.0.2":"Create Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.3":"Alter Role","1.3.6.1.4.1.33349.3.1.5.9.2.0.4":"Create Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.5":"Create Device","1.3.6.1.4.1.33349.3.1.5.9.2.0.6":"Create Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.7":"Administer Concept Dictionary","1.3.6.1.4.1.33349.3.1.5.9.2.0.8":"Alter Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.9":"Alter Policy","1.3.6.1.4.1.33349.3.1.5.9.2.0.10":"Administer Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.1":"Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0":"Login as a Service","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0":"OAUTH Login","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1":"OAUTH client_credentials flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.1.0":"OAUTH client_credentials flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2":"OAUTH password flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.2.0":"OAUTH password flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3":"OAUTH authoization code grant flow permission","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.3.0":"OAUTH authoization code grant flow permission no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4":"OAUTH Password Reset grant (extended permission)","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.0.4.0":"OAUTH Password Reset grant (extended permission) no device cred","1.3.6.1.4.1.33349.3.1.5.9.2.2":"Unrestricted Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.0":"Query Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.1":"Write Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.2":"Delete Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.3":"Read Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.2.4":"Export Clinical Data (PHI)","1.3.6.1.4.1.33349.3.1.5.9.2.999":"Override Disclosure","1.3.6.1.4.1.33349.3.1.5.9.2.4":"Unrestricted Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.4.0":"Read Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.10":"Access Client Administrative Function","1.3.6.1.4.1.33349.3.1.5.9.2.5":"Unrestricted Data Warehouse","1.3.6.1.4.1.33349.3.1.5.9.2.5.0":"Write Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.1":"Delete Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.2":"Read Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.5.3":"Query Warehouse Data","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.0":"Write Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.1.1":"Delete Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.2":"Read Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.1.3":"Query Materials","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.0":"Write Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.2.1":"Delete Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.2":"Read Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.4.0.2.3":"Query Places & Orgs","1.3.6.1.4.1.33349.3.1.5.9.2.0.11":"Access Audit Log","1.3.6.1.4.1.33349.3.1.5.9.2.0.12":"Administer Applets","1.3.6.1.4.1.33349.3.1.5.9.3":"Restricted Information / Confidential","1.3.6.1.4.1.33349.3.1.5.9.2.2.5":"Elevate Clinical Data","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.1":"Login for Password Reassignment","1.3.6.1.4.1.33349.3.1.5.9.2.600":"Special Security Elevation","1.3.6.1.4.1.33349.3.1.5.9.2.600.1":"Change Security Challenge Question","1.3.6.1.4.1.33349.3.1.5.9.2.1.0.2":"Allow Impersonation of Application","1.3.6.1.4.1.33349.3.1.5.9.2.0.4.1":"Create Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.0.8.1":"Alter Local Users","1.3.6.1.4.1.33349.3.1.5.9.2.2.6":"Unrestricted Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.1":"Write Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.2.6.2":"Read Non-PHI CDR Acts","1.3.6.1.4.1.33349.3.1.5.9.2.0.18":"Manage System Backups","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1":"Create System Backup on (Private or Public)","1.3.6.1.4.1.33349.3.1.5.9.2.0.18.1.1":"Create Private System Backup","1.3.6.1.4.1.33349.3.1.5.9.2.0.19":"Unrestricted Security Certificate Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.1":"Issue New Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.2":"Revoke Certificates","1.3.6.1.4.1.33349.3.1.5.9.2.0.19.3":"Assign Certificate to Security Identity","1.3.6.1.4.1.33349.3.1.5.9.2.0.15":"Alter System Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.17":"Administer Internal Mail / Messages","1.3.6.1.4.1.33349.3.1.5.9.2.0.20":"Manage Foreign Data","1.3.6.1.4.1.33349.3.1.5.9.2.0.21":"Unrestricted Access to Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.1":"Read Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.21.2":"Delete Service Logs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22":"Unrestricted Job Management","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.0":"Read System Jobs","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.1":"Start/Run System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.2":"Alter System Job Schedule","1.3.6.1.4.1.33349.3.1.5.9.2.0.22.3":"Register New System Job","1.3.6.1.4.1.33349.3.1.5.9.2.0.13":"Assign Policy","1.3.6.1.4.1.33349.3.1.5.9.2.500":"Export CDR Metadata","1.3.6.1.4.1.33349.3.1.5.9.2.900":"Login Any Facility","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1":"Unrestricted Match Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.1":"Alter Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.1.2":"Disable/Enable Match Configurations","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2":"Unrestricted Clinical Protocol Configuration","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.0":"Create Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.1":"Alter Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.2.2":"Delete Clinical Protocol","1.3.6.1.4.1.33349.3.1.5.9.2.0.15.3":"Alter Clinical Data Templates","1.3.6.1.4.1.33349.3.1.5.9.2.0.14":"Unrestricted PubSub Administration","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.1":"Create/Alter PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.2":"Disable/Enable PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.3":"Delete PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.14.4":"Read PubSub Subscriptions","1.3.6.1.4.1.33349.3.1.5.9.2.0.16":"Unrestricted Dispatcher Queue","1.3.6.1.4.1.33349.3.1.5.9.2.100":"Access All SanteDB Tools","1.3.6.1.4.1.33349.3.1.5.9.2.100.1":"Access SanteDB Administrator Panel","1.3.6.1.4.1.33349.3.1.5.9.2.100.2":"Access SanteEMR Clinical Interface","1.3.6.1.4.1.33349.3.1.5.9.2.6":"Unrestricted MDM","1.3.6.1.4.1.33349.3.1.5.9.2.6.1":"Write MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.2":"Read MDM Locals","1.3.6.1.4.1.33349.3.1.5.9.2.6.3":"Merge MDM Master","1.3.6.1.4.1.33349.3.1.5.9.2.6.4":"Establish MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.6.4.1":"Edit Existing MDM Record of Truth","1.3.6.1.4.1.33349.3.1.5.9.2.300":"Unrestricted IMS Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1":"Unrestricted Stock Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.0":"View Clinic Stock Information","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.1":"Alter Clinic Stock Stores","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.2":"Perform Stock Count","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.3":"Manage Clinic Vaccination Sessions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.4":"Perform Stock Adjustment","1.3.6.1.4.1.33349.3.1.5.9.2.200":"Unrestricted EMR Functions","1.3.6.1.4.1.33349.3.1.5.9.2.300.1.5":"Perform Stock Store Temperature Monitoring","1.3.6.1.4.1.33349.3.1.5.9.2.300.2":"Unrestricted Order Management","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.1":"Create or Cancel Order Request","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.2":"Accept and Despatch Order Requests","1.3.6.1.4.1.33349.3.1.5.9.2.300.2.3":"Accept Order Despatch","1.3.6.1.4.1.33349.3.1.5.9.2.200.1":"Clinic Reporting","2.25.70100936533247523356621147216786164046":"Emergency Use Only"}}}}},"schemas":{"Object":{"properties":{},"type":"object"},"RestServiceFault":{"xml":{"attribute":false,"namespace":"http://santedb.org/fault"},"properties":{"data":{"xml":{"name":"data","attribute":false},"description":"Gets or sets any additional data","type":"array","items":{"type":"string"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type of fault","type":"string"},"message":{"xml":{"name":"message","attribute":false},"description":"Gets or sets the message","type":"string"},"stack":{"xml":{"name":"stack","attribute":false},"description":"Detail of exception","type":"string"},"policyId":{"xml":{"name":"policyId","attribute":false},"description":"Policy ID was violated","type":"string"},"policyName":{"xml":{"name":"policyName","attribute":false},"description":"Policy name that was violated","type":"string"},"policyOutcome":{"xml":{"name":"policyOutcome","attribute":false},"description":"Policy ID was violated","type":"string","enum":["Deny","Elevate","Grant"]},"detail":{"xml":{"name":"detail","attribute":false},"description":"Detail of exception","type":"string"},"cause":{"xml":{"name":"cause","attribute":false},"description":"Gets or sets the caused by","schema":{"$ref":"#/components/schemas/RestServiceFault"}},"rule":{"xml":{"name":"rule","attribute":false},"description":"Gets or sets the rules","type":"array","items":{"$ref":"#/components/schemas/DetectedIssue","type":"object"}}},"description":"REST service fault wrapper","type":"object"},"DetectedIssue":{"xml":{"attribute":false,"namespace":"http://santedb.org/issue"},"properties":{"id":{"xml":{"name":"id","attribute":true},"description":"Gets or sets the identifier of the detected issue","type":"string"},"priority":{"xml":{"name":"priority","attribute":true},"description":"Represents a detected issue priority","type":"string","enum":["Error","Warning","Information"]},"text":{"description":"Gets or sets the textual description of the detected issue.","type":"string"},"type":{"xml":{"name":"type","attribute":true},"description":"The type of detected issue (a concept key) which can be used to classify the detected issue","type":"string","format":"uuid"},"refersTo":{"xml":{"name":"refersTo","attribute":true},"description":"Gets or sets the object that the detected issue refers to","type":"string"}},"description":"An issue raised by CDSS, Business Rules, or the persistence layer representing a constraint on the object","type":"object"},"ParameterCollection":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"parameter":{"xml":{"name":"parameter","attribute":false},"description":"Gets or sets the parameters","type":"array","items":{"$ref":"#/components/schemas/Parameter","type":"object"}}},"description":"Gets the operation invokation","type":"object"},"Parameter":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the operation","type":"string"},"int":{"xml":{"name":"int","attribute":false},"description":"Gets or sets the value of the parameter","schema":{"$ref":"#/components/schemas/Object"}}},"description":"REST service fault wrapper","type":"object"}}},"paths":{"/MailboxMailMessage/$xref-use":{"post":{"tags":["MailboxMailMessage"],"summary":"Invokes the specified operation","parameters":[{"schema":{"type":"string"},"name":"_viewModel","in":"query","description":"When using the view model serializer - specifies the view model definition to use which will load properties and return them inline in the response","required":false}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Object"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Object"}}}},"400":{"description":"The provided resource was in an incorrect format","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"401":{"description":"The principal is unauthorized and needs to either elevate or authenticate themselves","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"403":{"description":"The principal is not permitted (cannot elevate) to perform the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"404":{"description":"The requested object does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"410":{"description":"The specified object did exist however is no-longer present","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"415":{"description":"The client is submitting an invalid object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"422":{"description":"There was a business rule violation executing the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"429":{"description":"The server rejected the request due to a throttling constraint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"500":{"description":"The server encountered an error processing the result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}},"503":{"description":"The service is not available (starting up or shutting down)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestServiceFault"}}}}},"deprecated":false,"requestBody":{"content":{"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/json":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}},"application/xml":{"schema":{"$ref":"#/components/schemas/ParameterCollection"}}},"description":"The parameters to invoke the operation with"}}}}}
```