> 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/patient.md).

# Patient

Represents an entity which is a patient

## GET /Patient/\_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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/_export":{"get":{"tags":["Patient"],"summary":"Get the dataset for the specified object","parameters":[{"schema":{"type":"string"},"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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 /Patient/{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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}/_export":{"get":{"tags":["Patient"],"summary":"Get the dataset for the specified object","parameters":[{"schema":{"type":"string"},"name":"id","in":"path"},{"schema":{"type":"string"},"name":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient":{"get":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient":{"post":{"tags":["Patient"],"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/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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/Patient"}},"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}},"description":"The body of the request"}}}}}
```

## OPTIONS /Patient

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/Patient":{"options":{"tags":["Patient"],"summary":"Returns specific options for a single resource","responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/Patient":{"head":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}":{"get":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}":{"post":{"tags":["Patient"],"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/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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/Patient"}},"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}":{"put":{"tags":["Patient"],"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/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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/Patient"}},"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}":{"delete":{"tags":["Patient"],"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/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[],"paths":{"/Patient/{id}":{"head":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}":{"patch":{"tags":["Patient"],"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"}}}}}
```

## Gets a complete history of all changes made to the specified resource

> The result of the history operation is a

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}/_history":{"get":{"tags":["Patient"],"summary":"Gets a complete history of all changes made to the specified resource","description":"The result of the history operation is a","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource to retrieve"},{"schema":{"type":"string"},"name":"_since","in":"query","description":"The last version of the object that should be returned","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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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}}}}
```

## 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$diff":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$carepath-recompute":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$tag":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$analyze":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$carepath-unenroll":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$match":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$generate-careplan":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$validate":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$carepath-eligibilty":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$carepath-enroll":{"post":{"tags":["Patient"],"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/{id}/$match-reset":{"post":{"tags":["Patient"],"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"}}}}}
```

## Retrieves a specific version of the specified resource

> This method allows the caller to retrieve a specific version of the identified object, which is useful for loading a previous copy of a resource for reference.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}/_history/{versionId}":{"get":{"tags":["Patient"],"summary":"Retrieves a specific version of the specified resource","description":"This method allows the caller to retrieve a specific version of the identified object, which is useful for loading a previous copy of a resource for reference.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identifier of the resource for which history sould be retrieved"},{"schema":{"type":"string"},"name":"versionId","in":"path","description":"The version of the resource to retrieve"},{"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}/_code":{"get":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Patient":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"multipleBirthOrder":{"xml":{"name":"multipleBirthOrder","attribute":false},"description":"Gets or sets the multiple birth order of the patient","type":"number","format":"int32"},"livingArrangement":{"xml":{"name":"livingArrangement","attribute":false},"description":"Gets or sets the living arrangement","type":"string","format":"uuid"},"religion":{"xml":{"name":"religion","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"ethnicity":{"xml":{"name":"ethnicity","attribute":false},"description":"Gets or sets the ethnicity codes","type":"string","format":"uuid"},"educationLevel":{"xml":{"name":"educationLevel","attribute":false},"description":"Gets or sets the key of the education level","type":"string","format":"uuid"},"dateOfBirthPrecision":{"xml":{"name":"dateOfBirthPrecision","attribute":false},"description":"Gets or sets the precision ofthe date of birth","type":"string","enum":["F","Y","m","D","H","M","S"]},"genderConcept":{"xml":{"name":"genderConcept","attribute":false},"description":"Gets or sets the gender concept key","type":"string","format":"uuid"},"dateOfBirth":{"xml":{"name":"dateOfBirth","attribute":false},"description":"Gets the date of birth as XML","type":"string"},"language":{"xml":{"name":"language","attribute":false},"description":"Gets the person's languages of communication","type":"array","items":{"$ref":"#/components/schemas/PersonLanguageCommunication","type":"object"}},"occupation":{"xml":{"name":"occupation","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"maritalStatus":{"xml":{"name":"maritalStatus","attribute":false},"description":"Gets or sets the key of the marital status concept","type":"string","format":"uuid"},"deceasedDate":{"xml":{"name":"deceasedDate","attribute":false},"description":"Deceased date XML","type":"string"},"deceasedDatePrecision":{"xml":{"name":"deceasedDatePrecision","attribute":false},"description":"Gets or sets the precision of the date of deceased","type":"string","enum":["F","Y","m","D","H","M","S"]},"vipStatus":{"xml":{"name":"vipStatus","attribute":false},"description":"Gets or sets the VIP code","type":"string","format":"uuid"},"nationality":{"xml":{"name":"nationality","attribute":false},"description":"Gets or sets the religious affiliation","type":"string","format":"uuid"},"address":{"xml":{"name":"address","attribute":false},"description":"Gets a list of all addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityAddress","type":"object"}},"classConcept":{"xml":{"name":"classConcept","attribute":false},"description":"Class concept","type":"string","format":"uuid"},"creationAct":{"xml":{"name":"creationAct","attribute":false},"description":"Creation act reference","type":"string","format":"uuid"},"determinerConcept":{"xml":{"name":"determinerConcept","attribute":false},"description":"Determiner concept","type":"string","format":"uuid"},"extension":{"xml":{"name":"extension","attribute":false},"description":"Gets a list of all extensions associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityExtension","type":"object"}},"identifier":{"xml":{"name":"identifier","attribute":false},"description":"Gets the identifiers associated with this entity","type":"array","items":{"$ref":"#/components/schemas/EntityIdentifier","type":"object"}},"name":{"xml":{"name":"name","attribute":false},"description":"Gets a list of all names associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityName","type":"object"}},"note":{"xml":{"name":"note","attribute":false},"description":"Gets a list of all notes associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityNote","type":"object"}},"participation":{"xml":{"name":"participation","attribute":false},"description":"Gets the acts in which this entity participates","type":"array","items":{"$ref":"#/components/schemas/ActParticipation","type":"object"}},"relationship":{"xml":{"name":"relationship","attribute":false},"description":"Gets a list of all associated entities for this entity","type":"array","items":{"$ref":"#/components/schemas/EntityRelationship","type":"object"}},"statusConcept":{"xml":{"name":"statusConcept","attribute":false},"description":"Status concept id","type":"string","format":"uuid"},"tag":{"xml":{"name":"tag","attribute":false},"description":"Gets a list of all tags associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTag","type":"object"}},"telecom":{"xml":{"name":"telecom","attribute":false},"description":"Gets a list of all telecommunications addresses associated with the entity","type":"array","items":{"$ref":"#/components/schemas/EntityTelecomAddress","type":"object"}},"template":{"xml":{"name":"template","attribute":false},"description":"Gets the template key","type":"string","format":"uuid"},"typeConcept":{"xml":{"name":"typeConcept","attribute":false},"description":"Type concept identifier","type":"string","format":"uuid"},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the security policy instances associated with the entity","type":"array","items":{"$ref":"#/components/schemas/SecurityPolicyInstance","type":"object"}},"geo":{"xml":{"name":"geo","attribute":false},"description":"Gets or sets the geo tag","schema":{"$ref":"#/components/schemas/GeoTag"}},"previousVersion":{"xml":{"name":"previousVersion","attribute":false},"description":"Gets or sets the UUID of the previous version of this record","type":"string","format":"uuid"},"version":{"xml":{"name":"version","attribute":false},"description":"Gets or sets the UUID of the current version of this object","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"The sequence number of the version (for ordering)","type":"number","format":"int64"},"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 an entity which is a patient","type":"object"},"PersonLanguageCommunication":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"isPreferred":{"xml":{"name":"isPreferred","attribute":false},"description":"Gets or set the user's preference indicator","type":"boolean"},"languageCode":{"xml":{"name":"languageCode","attribute":false},"description":"Gets or sets the language code","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":"Represents a single preferred communication method for the entity","type":"object"},"EntityAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the address use key","type":"string","format":"uuid"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the component types","type":"array","items":{"$ref":"#/components/schemas/AddressComponent","type":"object"}},"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":"A structured address for an entity","type":"object"},"AddressComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the order in which this element appears","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"A single address component","type":"object"},"EntityExtension":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the extension","type":"array","items":{"type":"number","format":"byte"}},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"extensionType":{"xml":{"name":"extensionType","attribute":false},"description":"Gets or sets the extension type key","type":"string","format":"uuid"},"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":"Extension bound to entity","type":"object"},"EntityIdentifier":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the identifier","type":"string"},"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"issued":{"xml":{"name":"issued","attribute":false},"description":"Serialization property for issued date","type":"string"},"expires":{"xml":{"name":"expires","attribute":false},"description":"Serialization field for expiry date","type":"string"},"checkDigit":{"xml":{"name":"checkDigit","attribute":false},"description":"Gets or sets the check-digit if it is stored separate from the identifier","type":"string"},"domain":{"xml":{"name":"domain","attribute":false},"description":"Gets or sets the assinging authority id","type":"string","format":"uuid"},"authority":{"xml":{"name":"authority","attribute":false},"description":"Authority - used for backwards compatibility only","schema":{"$ref":"#/components/schemas/IdentityDomain"}},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the type identifier","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of the identifier","type":"string","enum":["u","a","i"]},"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":"Entity identifiers","type":"object"},"IdentityDomain":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the assigning authority","type":"string"},"domainName":{"xml":{"name":"domainName","attribute":false},"description":"Gets or sets the domain name of the assigning authority","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the assigning authority","type":"string"},"oid":{"xml":{"name":"oid","attribute":false},"description":"Gets or sets the oid of the assigning authority","type":"string"},"url":{"xml":{"name":"url","attribute":false},"description":"The URL of the assigning authority","type":"string"},"assigningAuthority":{"xml":{"name":"assigningAuthority","attribute":false},"description":"Assigning device identifier","type":"array","items":{"$ref":"#/components/schemas/AssigningAuthority","type":"object"}},"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key associated with this assigning authority for disclosure","type":"string","format":"uuid"},"identifierClass":{"xml":{"name":"identifierClass","attribute":false},"description":"Gets or sets the identifier classification key","type":"string","format":"uuid"},"validation":{"xml":{"name":"validation","attribute":false},"description":"Gets or sets the validation regex","type":"string"},"isUnique":{"xml":{"name":"isUnique","attribute":false},"description":"True if the assigning authority values should be unique","type":"boolean"},"customValidator":{"xml":{"name":"customValidator","attribute":false},"description":"Gets or sets the IIdentifierValidator instance to use for this solution","type":"string"},"checkDigitAlgorithm":{"xml":{"name":"checkDigitAlgorithm","attribute":false},"description":"Gets or sets the check digit algorithm","type":"string"},"scope":{"xml":{"name":"scope","attribute":false},"description":"Represents scopes to which the authority is bound","type":"array","items":{"type":"string","format":"uuid"}},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 model class which is an assigning authority","type":"object"},"AssigningAuthority":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"assigningApplication":{"xml":{"name":"assigningApplication","attribute":false},"description":"Gets or sets the application which can assign identity","type":"string","format":"uuid"},"reliability":{"xml":{"name":"reliability","attribute":false},"description":"Gets or sets the reliability of identifiers assigned by this application","type":"string","enum":["u","a","i"]},"source":{"xml":{"name":"source","attribute":false},"description":"Gets the source entity key","type":"string","format":"uuid"},"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":"Indicates the reliability of an application to assign identifiers in a particular identity domain","type":"object"},"EntityName":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"component":{"xml":{"name":"component","attribute":false},"description":"Gets or sets the individual component types","type":"array","items":{"$ref":"#/components/schemas/EntityNameComponent","type":"object"}},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"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":"Represents a name for an entity","type":"object"},"EntityNameComponent":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the component type key","type":"string","format":"uuid"},"sequence":{"xml":{"name":"sequence","attribute":false},"description":"Gets or sets the sequence of this object in the component","type":"number","format":"int64"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the name component","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":"Represents a name component which is bound to a name","type":"object"},"EntityNote":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"text":{"xml":{"name":"text","attribute":false},"description":"Gets or sets the note text","type":"string"},"author":{"xml":{"name":"author","attribute":false},"description":"Gets or sets the author key","type":"string","format":"uuid"},"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":"Represents a note attached to an entity","type":"object"},"ActParticipation":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Identifies the classification of the participation.","type":"string","format":"uuid"},"player":{"xml":{"name":"player","attribute":false},"description":"Identifies the entity which played the","type":"string","format":"uuid"},"participationRole":{"xml":{"name":"participationRole","attribute":false},"description":"Identifies the role which the","type":"string","format":"uuid"},"act":{"xml":{"name":"act","attribute":false},"description":"Identifies the","type":"string","format":"uuid"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Identifies the number of","type":"number","format":"int32"},"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 an entity which participates in an act","type":"object"},"EntityRelationship":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"holder":{"xml":{"name":"holder","attribute":false},"description":"The entity that this relationship targets","type":"string","format":"uuid"},"negationInd":{"xml":{"name":"negationInd","attribute":false},"description":"A negation indicator - used to flag this relationship as negated","type":"boolean"},"strength":{"xml":{"name":"strength","attribute":false},"description":"The strength (confidence) of the relationship between source and target","type":"number","format":"double"},"quantity":{"xml":{"name":"quantity","attribute":false},"description":"Represents the quantity of target in source","type":"number","format":"int32"},"relationshipType":{"xml":{"name":"relationshipType","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"relationshipRole":{"xml":{"name":"relationshipRole","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"classification":{"xml":{"name":"classification","attribute":false},"description":"Association type key","type":"string","format":"uuid"},"target":{"xml":{"name":"target","attribute":false},"description":"The target of the association","type":"string","format":"uuid"},"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":"Represents an association between two entities","type":"object"},"EntityTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"key":{"xml":{"name":"key","attribute":false},"description":"Gets or sets the key of the tag","type":"string"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the tag","type":"string"},"source":{"xml":{"name":"source","attribute":false},"description":"Gets or sets the source entity's key (where the relationship is FROM)","type":"string","format":"uuid"},"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 tag associated with an entity","type":"object"},"EntityTelecomAddress":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"externId":{"xml":{"name":"externId","attribute":false},"description":"Gets or sets the external key for the object","type":"string"},"use":{"xml":{"name":"use","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"type":{"xml":{"name":"type","attribute":false},"description":"Gets or sets the name use key","type":"string","format":"uuid"},"value":{"xml":{"name":"value","attribute":false},"description":"Gets or sets the value of the telecom address","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":"Represents an entity telecom address","type":"object"},"SecurityPolicyInstance":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"policy":{"xml":{"name":"policy","attribute":false},"description":"Gets or sets the policy key","type":"string","format":"uuid"},"grant":{"xml":{"name":"grant","attribute":false},"description":"Gets or sets whether the policy is a Deny","type":"string","enum":["Deny","Elevate","Grant"]},"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":"Represents a security policy instance","type":"object"},"GeoTag":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the default modified on","type":"string","format":"date"},"lat":{"xml":{"name":"lat","attribute":false},"description":"Gets the latitude","type":"number","format":"double"},"lng":{"xml":{"name":"lng","attribute":false},"description":"Gets or sets the longitude of the object","type":"number","format":"double"},"precise":{"xml":{"name":"precise","attribute":false},"description":"Gets or sets the accuracy of the geo-tag","type":"boolean"},"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 simple geographic tagging attribute","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":{"/Patient/{id}/_ptr":{"get":{"tags":["Patient"],"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Patient"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Patient"}}}},"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}}}}
```

## GET /Patient/{id}/carepaths/{childResourceKey}

> Performs a linked or chained search on a sub-property

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"CarePathwayDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the care pathway","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the care pathway","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the care pathway","type":"string"},"eligibility":{"xml":{"name":"eligibility","attribute":false},"description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},"enrollment":{"xml":{"name":"enrollment","attribute":false},"description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},"encounterTemplate":{"xml":{"name":"encounterTemplate","attribute":false},"description":"Gets or sets the type of encounter","type":"string","format":"uuid"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 single care pathway","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":{"/Patient/{id}/carepaths/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the hosting (container object)"},{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch"},{"schema":{"type":"boolean"},"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}}}},"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}}}}
```

## Removes a child resource instance from the parent container

> This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"CarePathwayDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the care pathway","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the care pathway","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the care pathway","type":"string"},"eligibility":{"xml":{"name":"eligibility","attribute":false},"description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},"enrollment":{"xml":{"name":"enrollment","attribute":false},"description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},"encounterTemplate":{"xml":{"name":"encounterTemplate","attribute":false},"description":"Gets or sets the type of encounter","type":"string","format":"uuid"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 single care pathway","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":{"/Patient/{id}/carepaths/{childResourceKey}":{"delete":{"tags":["Patient"],"summary":"Removes a child resource instance from the parent container","description":"This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the container"},{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The actual value of the sub-key"},{"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/CarePathwayDefinition"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}}}},"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}}}}
```

## Removes a child resource instance from the parent container

> This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/{id}/match-ignore/{childResourceKey}":{"delete":{"tags":["Patient"],"summary":"Removes a child resource instance from the parent container","description":"This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the container"},{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The actual value of the sub-key"},{"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/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## GET /Patient/{id}/match-candidate/{childResourceKey}

> Performs a linked or chained search on a sub-property

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/{id}/match-candidate/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the hosting (container object)"},{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch"},{"schema":{"type":"boolean"},"name":"_bundle","in":"query","description":"True if the server should include related objects in a bundle to the caller","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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## Removes a child resource instance from the parent container

> This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/{id}/match-candidate/{childResourceKey}":{"delete":{"tags":["Patient"],"summary":"Removes a child resource instance from the parent container","description":"This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the container"},{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The actual value of the sub-key"},{"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/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## Performs a linked or chained search on a sub-property

> This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"CarePathwayDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the care pathway","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the care pathway","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the care pathway","type":"string"},"eligibility":{"xml":{"name":"eligibility","attribute":false},"description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},"enrollment":{"xml":{"name":"enrollment","attribute":false},"description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},"encounterTemplate":{"xml":{"name":"encounterTemplate","attribute":false},"description":"Gets or sets the type of encounter","type":"string","format":"uuid"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 single care pathway","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":{"/Patient/{id}/carepaths":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","description":"This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the hosting (container object)"},{"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}}}},"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}}}}
```

## Assigns the child object as a child (or link) of the parent

> This method adds a new child resource instance to the container and performs the necessary linking

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"CarePathwayDefinition":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"mnemonic":{"xml":{"name":"mnemonic","attribute":false},"description":"Gets or sets the mnemonic for the care pathway","type":"string"},"name":{"xml":{"name":"name","attribute":false},"description":"Gets or sets the name of the care pathway","type":"string"},"description":{"xml":{"name":"description","attribute":false},"description":"Gets or sets the description of the care pathway","type":"string"},"eligibility":{"xml":{"name":"eligibility","attribute":false},"description":"Gets or sets the eligibility criteria (when someone can be enroled to create a care plan)","type":"string"},"enrollment":{"xml":{"name":"enrollment","attribute":false},"description":"Gets or sets the enrolment mode","type":"string","enum":["manual","automatic"]},"encounterTemplate":{"xml":{"name":"encounterTemplate","attribute":false},"description":"Gets or sets the type of encounter","type":"string","format":"uuid"},"updatedTime":{"xml":{"name":"updatedTime","attribute":false},"description":"Gets or sets the time that this object was last modified in ISO format","type":"string"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time this item was modified","type":"string","format":"date"},"updatedBy":{"xml":{"name":"updatedBy","attribute":false},"description":"Gets or sets the provenance identifier associated with the last update of this object","type":"string","format":"uuid"},"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"},"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 single care pathway","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":{"/Patient/{id}/carepaths":{"post":{"tags":["Patient"],"summary":"Assigns the child object as a child (or link) of the parent","description":"This method adds a new child resource instance to the container and performs the necessary linking","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identiifer of the container"},{"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/CarePathwayDefinition"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}}}},"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/CarePathwayDefinition"}},"application/json":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CarePathwayDefinition"}}},"description":"The object to be added to the collection"}}}}}
```

## Performs a linked or chained search on a sub-property

> This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/{id}/match-candidate":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","description":"This method performs a general search on the child resource type, however scoped to the container of the parent (so users within role container)","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The key of the hosting (container object)"},{"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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## Assigns the child object as a child (or link) of the parent

> This method adds a new child resource instance to the container and performs the necessary linking

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/{id}/match-candidate":{"post":{"tags":["Patient"],"summary":"Assigns the child object as a child (or link) of the parent","description":"This method adds a new child resource instance to the container and performs the necessary linking","parameters":[{"schema":{"type":"string"},"name":"id","in":"path","description":"The identiifer of the container"},{"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/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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/Bundle"}},"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}},"description":"The object to be added to the collection"}}}}}
```

## POST /Patient/$analyze

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$analyze":{"post":{"tags":["Patient"],"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 /Patient/$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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$xsd-complete":{"post":{"tags":["Patient"],"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 /Patient/$match

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$match":{"post":{"tags":["Patient"],"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 /Patient/$expand

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$expand":{"post":{"tags":["Patient"],"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 /Patient/$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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$schema-complete":{"post":{"tags":["Patient"],"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 /Patient/$generate-careplan

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$generate-careplan":{"post":{"tags":["Patient"],"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 /Patient/$validate

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$validate":{"post":{"tags":["Patient"],"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 /Patient/$match-reset

> 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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$match-reset":{"post":{"tags":["Patient"],"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 /Patient/$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":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"/Patient/$xref-use":{"post":{"tags":["Patient"],"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"}}}}}
```

## GET /Patient/match-candidate

> Performs a linked or chained search on a sub-property

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/match-candidate":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## GET /Patient/match-candidate/{childResourceKey}

> Performs a linked or chained search on a sub-property

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.3","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/match-candidate/{childResourceKey}":{"get":{"tags":["Patient"],"summary":"Performs a linked or chained search on a sub-property","parameters":[{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The key of the sub-item to fetch"},{"schema":{"type":"boolean"},"name":"_bundle","in":"query","description":"True if the server should include related objects","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":"multipleBirthOrder","in":"query","description":"Gets or sets the multiple birth order of the patient"},{"schema":{"type":"string"},"name":"livingArrangement","in":"query","description":"Gets or sets the living arrangement"},{"schema":{"type":"string"},"name":"religion","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"ethnicity","in":"query","description":"Gets or sets the ethnicity codes"},{"schema":{"type":"string"},"name":"educationLevel","in":"query","description":"Gets or sets the key of the education level"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"dateOfBirthPrecision","in":"query","description":"Gets or sets the precision ofthe date of birth"},{"schema":{"type":"string"},"name":"genderConcept","in":"query","description":"Gets or sets the gender concept key"},{"schema":{"type":"string"},"name":"dateOfBirth","in":"query","description":"Gets the date of birth as XML"},{"schema":{"type":"string"},"name":"language","in":"query","description":"Gets the person's languages of communication"},{"schema":{"type":"string"},"name":"occupation","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"maritalStatus","in":"query","description":"Gets or sets the key of the marital status concept"},{"schema":{"type":"string"},"name":"deceasedDate","in":"query","description":"Deceased date XML"},{"schema":{"type":"string","enum":["F","Y","m","D","H","M","S"]},"name":"deceasedDatePrecision","in":"query","description":"Gets or sets the precision of the date of deceased"},{"schema":{"type":"string"},"name":"vipStatus","in":"query","description":"Gets or sets the VIP code"},{"schema":{"type":"string"},"name":"nationality","in":"query","description":"Gets or sets the religious affiliation"},{"schema":{"type":"string"},"name":"address","in":"query","description":"Gets a list of all addresses associated with the entity"},{"schema":{"type":"string"},"name":"classConcept","in":"query","description":"Class concept"},{"schema":{"type":"string"},"name":"creationAct","in":"query","description":"Creation act reference"},{"schema":{"type":"string"},"name":"determinerConcept","in":"query","description":"Determiner concept"},{"schema":{"type":"string"},"name":"extension","in":"query","description":"Gets a list of all extensions associated with the entity"},{"schema":{"type":"string"},"name":"identifier","in":"query","description":"Gets the identifiers associated with this entity"},{"schema":{"type":"string"},"name":"name","in":"query","description":"Gets a list of all names associated with the entity"},{"schema":{"type":"string"},"name":"note","in":"query","description":"Gets a list of all notes associated with the entity"},{"schema":{"type":"string"},"name":"participation","in":"query","description":"Gets the acts in which this entity participates"},{"schema":{"type":"string"},"name":"relationship","in":"query","description":"Gets a list of all associated entities for this entity"},{"schema":{"type":"string"},"name":"statusConcept","in":"query","description":"Status concept id"},{"schema":{"type":"string"},"name":"tag","in":"query","description":"Gets a list of all tags associated with the entity"},{"schema":{"type":"string"},"name":"telecom","in":"query","description":"Gets a list of all telecommunications addresses associated with the entity"},{"schema":{"type":"string"},"name":"template","in":"query","description":"Gets the template key"},{"schema":{"type":"string"},"name":"typeConcept","in":"query","description":"Type concept identifier"},{"schema":{"type":"string"},"name":"policy","in":"query","description":"Gets or sets the security policy instances associated with the entity"},{"schema":{"type":"string"},"name":"geo","in":"query","description":"Gets or sets the geo tag"},{"schema":{"type":"string"},"name":"etag","in":"query","description":"Override the ETag"},{"schema":{"type":"string"},"name":"previousVersion","in":"query","description":"Gets or sets the UUID of the previous version of this record"},{"schema":{"type":"boolean"},"name":"head","in":"query","description":"True if the object is the head version"},{"schema":{"type":"string"},"name":"version","in":"query","description":"Gets or sets the UUID of the current version of this object"},{"schema":{"type":"string"},"name":"sequence","in":"query","description":"The sequence number of the version (for ordering)"},{"schema":{"type":"string"},"name":"creationTime","in":"query","description":"Gets or sets the creation time as an ISO date format"},{"schema":{"type":"string"},"name":"obsoletionTime","in":"query","description":"Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format"},{"schema":{"type":"string"},"name":"modifiedOn","in":"query","description":"Gets the time that the object was last modified (from base data, default to CreationTime)"},{"schema":{"type":"string"},"name":"createdBy","in":"query","description":"Gets or sets the security provenance object which represents the creation of this object"},{"schema":{"type":"string"},"name":"obsoletedBy","in":"query","description":"Gets or sets the security provenance object which represents the obsoletion of this data"},{"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"}],"responses":{"200":{"description":"Operation was completed successfully","type":"object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```

## Removes a child resource instance from the parent container

> This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.

```json
{"openapi":"3.1.1","info":{"title":"Health Data Service Interface (HDSI)","version":"3.0.2087.0 (3.0.2087-alpha+44962b8b129307d368c5d1fac08f1f6c31d960ad)"},"tags":[{"description":"Represents an entity which is a patient","name":"Patient"}],"servers":[{"url":"https://ims-ncc1701.santesuite.net:8443/hdsi"}],"security":[{"svc_auth":["1.3.6.1.4.1.33349.3.1.5.9.2.2.1","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":{"Bundle":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets the time the bundle was modified","type":"string","format":"date"},"correlationSeq":{"xml":{"name":"correlationSeq","attribute":false},"description":"Gets or sets the sequence control for this bundle","type":"number","format":"int64"},"correlationId":{"xml":{"name":"correlationId","attribute":false},"description":"A unique identifier which correlates this bundle with other bundles that are about the same \"subject\"","type":"string","format":"uuid"},"resource":{"xml":{"name":"resource","attribute":false},"description":"Gets or sets items in the bundle","type":"array","items":{"$ref":"#/components/schemas/IdentifiedData","type":"object"}},"focal":{"xml":{"name":"focal","attribute":false},"description":"Entry into the bundle","type":"array","items":{"type":"string","format":"uuid"}},"offset":{"xml":{"name":"offset","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"count":{"xml":{"name":"count","attribute":false},"description":"Gets or sets the count in this bundle","type":"number","format":"int32"},"totalResults":{"xml":{"name":"totalResults","attribute":false},"description":"Gets or sets the total results","type":"number","format":"int32"},"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":"A bundle represents a batch of objects which are included within the bundle","type":"object"},"IdentifiedData":{"xml":{"attribute":false,"namespace":"http://santedb.org/model"},"properties":{"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"},"modifiedOn":{"xml":{"name":"modifiedOn","attribute":false},"description":"Gets or sets date/time that this object was last created or modified","type":"string","format":"date"}},"description":"A class which represent data which has a keyed identifier","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":{"/Patient/match-candidate/{childResourceKey}":{"delete":{"tags":["Patient"],"summary":"Removes a child resource instance from the parent container","description":"This method will unlink, or delete (depending on behavior of the provider) the child resource from the container.","parameters":[{"schema":{"type":"string"},"name":"childResourceKey","in":"path","description":"The actual value of the sub-key"},{"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/Bundle"}},"application/x.santedb.rim.viewModel+json":{"schema":{"$ref":"#/components/schemas/Bundle"}},"application/xml":{"schema":{"$ref":"#/components/schemas/Bundle"}}}},"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}}}}
```